Module ux_string

Description
Data Types
Function Index
Function Details

String functions.

Authors: Michael Uvarov (arcusfelis@gmail.com).

Function Index

delete_types/2	Returns a new string which is made from the chars of Str which are not a type from Types list.
delete_types/3	Stops delete_type/2 after Limit deleted chars.
explode/2	Splits the string by delimeters.
explode/3
explode_types/2	Returns a new list of strings which are parts of Str splited by separator chars of a type from Types list.
extract_words/1
filter_types/2	Returns a new string which is made from the chars of Str which are a type from Types list.
filter_types/3	Stops after -Limit skipped chars.
first/2	Return Len chars from the beginning of the string.
first_types/3	If Len<0, then gets first Len chars of type, which is in Types If Len>0, then gets first -Len chars of type, which is NOT in Types.
freq/1	Counts how many identical chars in the string.
is_nfc/1
is_nfd/1
is_nfkc/1
is_nfkd/1
last/2	Return Len chars from the beginning of the string.
last_types/3	If Len<0, then gets last Len chars of type, which is in Types If Len>0, then gets last -Len chars of type, which is NOT in Types.
length/1	Compute count of graphemes in the string.
reverse/1	Reverses the string graphemes.
script/1
scripts/1
split/2
split/3
split_types/2	Returns a new list of strings which are parts of Str splited by separator chars of a type from Types list.
to_graphemes/1	Split unicode string into [graphemes](http://en.wikipedia.org/wiki/Grapheme).
to_lower/1	Converts characters of a string to a lowercase format.
to_ncr/1	Convert everything from utf-8 into an NCR (Numeric Character Reference).
to_nfc/1
to_nfd/1
to_nfkc/1
to_nfkd/1
to_string/1	Converts something to string (list).
to_upper/1	Converts characters of a string to a uppercase format.
types/1	Returns various "character types" which can be used as a default categorization in implementations.

Function Details

delete_types/2

delete_types(Types::[char_type()], Str::string()) -> string() | none()

Returns a new string which is made from the chars of Str which are not a type from Types list.

delete_types/3

delete_types(Types::[char_type()], Str::string(), Limit::integer()) -> string() | none()

Stops delete_type/2 after Limit deleted chars. If Limit < 0, then stops after -Limit skipped chars.

explode/2

explode(Delimeter::[nonempty_string()], Str::string()) -> [string()]

explode(Delimeter::char(), Str::string()) -> [string()]

explode(Delimeter::nonempty_string(), Str::string()) -> [string()]

Splits the string by delimeters.

explode/3

explode(Delimeter::[nonempty_string()], Str::string(), Limit::integer()) -> string()

explode(Delimeter::char(), Str::string(), Limit::integer()) -> [string()]

explode(Delimeter::nonempty_string(), Str::string(), Limit::integer()) -> [string()]

explode_types/2

explode_types(Types::[char_type()], Str::string()) -> string()

Returns a new list of strings which are parts of Str splited by separator chars of a type from Types list.

filter_types/2

filter_types(Types::[char_type()], Str::string()) -> string() | none()

Returns a new string which is made from the chars of Str which are a type from Types list.

filter_types/3

filter_types(Types::[char_type()], Str::string(), Limit::integer()) -> string() | none()

Stops after -Limit skipped chars.

first/2

first(Str, Len) -> any()

Return Len chars from the beginning of the string.

first_types/3

first_types(Types::[char_type()], Str::string(), Len::integer()) -> string() | none()

If Len<0, then gets first Len chars of type, which is in Types If Len>0, then gets first -Len chars of type, which is NOT in Types

freq/1

freq(Str) -> any()

Counts how many identical chars in the string. Returns a dict. Example:

  >dict:to_list(ux_string:freq("FFDF")).
  [{70,3},{68,1}]

is_nfc/1

is_nfc(Str::list()) -> yes | no | 'maybe'

is_nfd/1

is_nfd(Str::list()) -> yes | no | 'maybe'

is_nfkc/1

is_nfkc(Str::list()) -> yes | no | 'maybe'

is_nfkd/1

is_nfkd(Str::list()) -> yes | no | 'maybe'

last/2

last(Str, Len) -> any()

Return Len chars from the beginning of the string.

last_types/3

last_types(Types::[char_type()], Str::string(), Len::integer()) -> string() | none()

If Len<0, then gets last Len chars of type, which is in Types If Len>0, then gets last -Len chars of type, which is NOT in Types

length/1

length(S) -> any()

Compute count of graphemes in the string.

reverse/1

reverse(Str) -> any()

Reverses the string graphemes.

split_types/2

split_types(Types::[char_type()], Str::string()) -> string()

Returns a new list of strings which are parts of Str splited by separator chars of a type from Types list. Parts can not be empty.

to_graphemes/1

to_graphemes(Str) -> any()

Split unicode string into [graphemes](http://en.wikipedia.org/wiki/Grapheme). Based on [UAX29: UNICODE TEXT SEGMENTATION] (http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries).

It is important to recognize that what the user thinks of as a "character"—a basic unit of a writing system for a language—may not be just a single Unicode code point. Instead, that basic unit may be made up of multiple Unicode code points. To avoid ambiguity with the computer use of the term character, this is called a user-perceived character. For example, “G” + acute-accent is a user-perceived character: users think of it as a single character, yet is actually represented by two Unicode code points. These user-perceived characters are approximated by what is called a grapheme cluster, which can be determined programmatically.

Generated by EDoc