string
String Processing Functions
This module contains functions for string processing.
Functions
len/1
Returns the number of characters in the string.
equal/2
Tests whether two strings are equal. Returns true
if
they are, otherwise false
.
concat/2
Concatenates two strings to form a new string. Returns the new string.
chr/2
rchr/2
Returns the index of the first/last occurrence of
in
. 0
is returned if
does not
occur.
str/2
rstr/2
Returns the position where the first/last occurrence of
begins in
. 0
is returned if
does not exist in
.
For example:
> string:str(" Hello Hello World World ", "Hello World"). 8
span/2
cspan/2
Returns the length of the maximum initial segment of
, which consists entirely of characters from (not
from)
.
For example:
> string:span("\t abcdef", " \t"). 5 > string:cspan("\t abcdef", " \t"). 0
substr/2
substr/3
Returns a substring of
, starting at the
position
, and ending at the end of the string or
at length
.
For example:
> substr("Hello World", 4, 5). "lo Wo"
tokens/2
Returns a list of tokens in
, separated by the
characters in
.
For example:
> tokens("abc defxxghix jkl", "x "). ["abc", "def", "ghi", "jkl"]
join/2
Returns a string with the elements of
separated by the string in
.
For example:
> join(["one", "two", "three"], ", "). "one, two, three"
chars/2
chars/3
Returns a string consisting of
of characters
. Optionally, the string can end with the
string
.
copies/2
Returns a string containing
repeated
times.
words/1
words/2
Returns the number of words in
, separated by
blanks or
.
For example:
> words(" Hello old boy!", $o). 4
sub_word/2
sub_word/3
Returns the word in position
of
.
Words are separated by blanks or
s.
For example:
> string:sub_word(" Hello old boy !",3,$o). "ld b"
strip/1
strip/2
strip/3
Returns a string, where leading and/or trailing blanks or a
number of
have been removed.
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/2
left/3
Returns the
with the length adjusted in
accordance with
. The left margin is
fixed. If the length(
<
,
is padded with blanks or
s.
For example:
> string:left("Hello",10,$.). "Hello....."
right/2
right/3
Returns the
with the length adjusted in
accordance with
. The right margin is
fixed. If the length of (
<
,
is padded with blanks or
s.
For example:
> string:right("Hello", 10, $.). ".....Hello"
centre/2
centre/3
Returns a string, where
is centred in the
string and surrounded by blanks or characters. The resulting
string will have the length
.
sub_string/2
sub_string/3
Returns a substring of
, starting at the
position
to the end of the string, or to and
including the
position.
For example:
sub_string("Hello World", 4, 8). "lo Wo"
to_float/1
Argument
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
.
Example:
> {F1,Fs} = string:to_float("1.0-1.0e-1"), > {F2,[]} = string:to_float(Fs), > F1+F2. 0.9 > string:to_float("3/2=1.5"). {error,no_float} > string:to_float("-1.5eX"). {-1.5,"eX"}
to_integer/1
Argument
is expected to start with a valid text
represented integer (the digits being ASCII values). Remaining characters
in the string after the integer are returned in
.
Example:
> {I1,Is} = string:to_integer("33+22"), > {I2,[]} = string:to_integer(Is), > I1-I2. 11 > string:to_integer("0.5"). {0,".5"} > string:to_integer("x=2"). {error,no_integer}
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.
Note!
Any undocumented functions in string
should not be used.