substr(String, Start) -> SubString

substr(String, Start, Length) -> SubString

Returns a substring of String, starting at the
position Start, and ending at the end of the string or
at length Length.

For example:

> substr("Hello World", 4, 5).
"lo Wo"

tokens(String, SeparatorList) -> Tokens

String = SeparatorList = string()

Tokens = [Token :: nonempty_string()]

Returns a list of tokens in String, separated by the
characters in SeparatorList.

For example:

> tokens("abc defxxghix jkl", "x ").
["abc", "def", "ghi", "jkl"]

join(StringList, Separator) -> String

StringList = [string()]

Separator = String = string()

Returns a string with the elements of StringList
separated by the string in Separator.

For example:

> join(["one", "two", "three"], ", ").
"one, two, three"

chars(Character, Number) -> String

Character = char()

Number = integer() >= 0

String = string()

chars(Character, Number, Tail) -> String

Character = char()

Number = integer() >= 0

Tail = String = string()

Returns a string consisting of Number of characters
Character. Optionally, the string can end with the
string Tail.

copies(String, Number) -> Copies

String = Copies = string()

Number = integer() >= 0

Returns a string containing String repeated
Number times.

words(String) -> Count

String = string()

Count = integer() >= 1

words(String, Character) -> Count

String = string()

Character = char()

Count = integer() >= 1

Returns the number of words in String, separated by
blanks or Character.

For example:

> words(" Hello old boy!", $o).
4

sub_word(String, Number) -> Word

String = Word = string()

Number = integer()

sub_word(String, Number, Character) -> Word

String = Word = string()

Number = integer()

Character = char()

Returns the word in position Number of String.
Words are separated by blanks or Characters.

For example:

> string:sub_word(" Hello old boy !",3,$o).
"ld b"

strip(String :: string()) -> string()

strip(String, Direction) -> Stripped

String = Stripped = string()

Direction = left | right | both

strip(String, Direction, Character) -> Stripped

String = Stripped = string()

Direction = left | right | both

Character = char()

Returns a string, where leading and/or trailing blanks or a
number of Character have been removed.
Direction can be left, right, or
both and indicates from which direction blanks are to be
removed. The function strip/1 is equivalent to
strip(String, both).

For example:

> string:strip("...Hello.....", both, $.).
"Hello"

left(String, Number) -> Left

String = Left = string()

Number = integer() >= 0

left(String, Number, Character) -> Left

String = Left = string()

Number = integer() >= 0

Character = char()

Returns the String with the length adjusted in
accordance with Number. The left margin is
fixed. If the length(String) < Number,
String is padded with blanks or Characters.

For example:

> string:left("Hello",10,$.).
"Hello....."

right(String, Number) -> Right

String = Right = string()

Number = integer() >= 0

right(String, Number, Character) -> Right

String = Right = string()

Number = integer() >= 0

Character = char()

Returns the String with the length adjusted in
accordance with Number. The right margin is
fixed. If the length of (String) < Number,
String is padded with blanks or Characters.

For example:

> string:right("Hello", 10, $.).
".....Hello"

centre(String, Number) -> Centered

String = Centered = string()

Number = integer() >= 0

centre(String, Number, Character) -> Centered

String = Centered = string()

Number = integer() >= 0

Character = char()

Returns a string, where String is centred in the
string and surrounded by blanks or characters. The resulting
string will have the length Number.

sub_string(String, Start) -> SubString

String = SubString = string()

Start = integer() >= 1

sub_string(String, Start, Stop) -> SubString

String = SubString = string()

Start = Stop = integer() >= 1

Returns a substring of String, starting at the
position Start to the end of the string, or to and
including the Stop position.

For example:

sub_string("Hello World", 4, 8).
"lo Wo"

to_float(String) -> {Float,Rest} | {error,Reason}

String = string()

Float = float()

Rest = string()

Reason = no_float | not_a_list

Argument String is expected to start with a valid text
represented float (the digits being ASCII values). Remaining characters
in the string after the float are returned in Rest.

to_lower(String) -> Result

to_lower(Char) -> CharResult

to_upper(String) -> Result

to_upper(Char) -> CharResult

The given string or character is case-converted. Note that
the supported character set is ISO/IEC 8859-1 (a.k.a. Latin 1),
all values outside this set is unchanged

Notes

Some of the general string functions may seem to overlap each
other. The reason for this is that this string package is the
combination of two earlier packages and all the functions of
both packages have been retained.