Built-in String Functions

The following standard methods (mostly defined in the MoreStringPackage but excluded if using a raw Engine) operate on strings:

FunctionParameter(s)Description
len method and propertynonereturns the number of characters (not number of bytes) in the string
pad1) target length
2) character/string to pad
pads the string with a character or a string to at least a specified length
+= operator, appendcharacter/string to appendAdds a character or a string to the end of another string
clearnoneempties the string
truncatetarget lengthcuts off the string at exactly a specified number of characters
containscharacter/sub-string to search forchecks if a certain character or sub-string occurs in the string
index_of1) character/sub-string to search for
2) (optional) start index
returns the index that a certain character or sub-string occurs in the string, or -1 if not found
sub_string1) start index
2) (optional) number of characters to extract, none if < 0
extracts a sub-string (to the end of the string if length is not specified)
splitdelimiter character/stringsplits the string by the specified delimiter, returning an array of string segments; not available under no_index
crop1) start index
2) (optional) number of characters to retain, none if < 0
retains only a portion of the string
replace1) target character/sub-string
2) replacement character/string
replaces a sub-string with another
trimnonetrims the string of whitespace at the beginning and end

Examples


#![allow(unused)]
fn main() {
let full_name == " Bob C. Davis ";
full_name.len == 14;

full_name.trim();
full_name.len == 12;
full_name == "Bob C. Davis";

full_name.pad(15, '$');
full_name.len == 15;
full_name == "Bob C. Davis$$$";

let n = full_name.index_of('$');
n == 12;

full_name.index_of("$$", n + 1) == 13;

full_name.sub_string(n, 3) == "$$$";

full_name.truncate(6);
full_name.len == 6;
full_name == "Bob C.";

full_name.replace("Bob", "John");
full_name.len == 7;
full_name == "John C.";

full_name.contains('C') == true;
full_name.contains("John") == true;

full_name.crop(5);
full_name == "C.";

full_name.crop(0, 1);
full_name == "C";

full_name.clear();
full_name.len == 0;
}