From ccb3f7f9768d3c28783c771df47eec1829e51802 Mon Sep 17 00:00:00 2001 From: Dan Gudmundsson Date: Thu, 29 Jun 2017 12:36:25 +0200 Subject: Deprecate old string functions They should not be used. --- lib/stdlib/doc/src/string.xml | 396 +----------------------------------------- 1 file changed, 3 insertions(+), 393 deletions(-) (limited to 'lib/stdlib/doc/src') diff --git a/lib/stdlib/doc/src/string.xml b/lib/stdlib/doc/src/string.xml index 9d5edd9ecf..130fc74a28 100644 --- a/lib/stdlib/doc/src/string.xml +++ b/lib/stdlib/doc/src/string.xml @@ -109,10 +109,8 @@

This module has been reworked in Erlang/OTP 20 to handle unicode:chardata() and operate on grapheme - clusters. The old - functions that only work on Latin-1 lists as input - are still available but should not be - used. They will be deprecated in Erlang/OTP 21. + clusters. The old functions that only work on Latin-1 lists as input + are kept for backwards compatibility reasons but should not be used.

@@ -594,7 +592,7 @@ ÖÄÅ or both, indicates from which direction characters are to be removed.

-

Default Characters are the set of +

Default Characters is the set of nonbreakable whitespace codepoints, defined as Pattern_White_Space in Unicode Standard Annex #31. @@ -631,393 +629,5 @@ ÖÄÅ - -

- - Obsolete API functions -

Here follows the function of the old API. - These functions only work on a list of Latin-1 characters. -

-

- The functions are kept for backward compatibility, but are - not recommended. - They will be deprecated in Erlang/OTP 21. -

-

Any undocumented functions in string are not to be used.

- -
- - - - - - Center a string. - -

Returns a string, where String is centered in the - string and surrounded by blanks or Character. - The resulting string has length Number.

-

This function is obsolete. - Use - pad/3. -

- - - - - - - Return a string consisting of numbers of characters. - -

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

-

This function is obsolete. - Use - lists:duplicate/2.

- - - - - - Return the index of the first occurrence of - a character in a string. - -

Returns the index of the first occurrence of - Character in String. Returns - 0 if Character does not occur.

-

This function is obsolete. - Use - find/2.

- - - - - - Concatenate two strings. - -

Concatenates String1 and - String2 to form a new string - String3, which is returned.

-

- This function is obsolete. - Use [String1, String2] as - Data argument, and call - - unicode:characters_to_list/2 or - - unicode:characters_to_binary/2 - to flatten the output. -

- - - - - - Copy a string. - -

Returns a string containing String repeated - Number times.

-

This function is obsolete. - Use - lists:duplicate/2.

- - - - - - Span characters at start of a string. - -

Returns the length of the maximum initial segment of - String, which consists entirely of characters - not from Chars.

-

This function is obsolete. - Use - take/3.

-

Example:

- -> string:cspan("\t abcdef", " \t"). -0 - - - - - - Join a list of strings with separator. - -

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

-

This function is obsolete. - Use - lists:join/2.

-

Example:

- -> join(["one", "two", "three"], ", "). -"one, two, three" - - - - - - - Adjust left end of a string. - -

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

-

This function is obsolete. - Use - pad/2 or - pad/3.

-

Example:

- -> string:left("Hello",10,$.). -"Hello....." - - - - - - Return the length of a string. - -

Returns the number of characters in String.

-

This function is obsolete. - Use - length/1.

- - - - - - Return the index of the last occurrence of - a character in a string. - -

Returns the index of the last occurrence of - Character in String. Returns - 0 if Character does not occur.

-

This function is obsolete. - Use - find/3.

- - - - - - - Adjust right end of a string. - -

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

-

This function is obsolete. - Use - pad/3.

-

Example:

- -> string:right("Hello", 10, $.). -".....Hello" - - - - - - Find the index of a substring. - -

Returns the position where the last occurrence of - SubString begins in String. - Returns 0 if SubString - does not exist in String.

-

This function is obsolete. - Use - find/3.

-

Example:

- -> string:rstr(" Hello Hello World World ", "Hello World"). -8 - - - - - - Span characters at start of a string. - -

Returns the length of the maximum initial segment of - String, which consists entirely of characters - from Chars.

-

This function is obsolete. - Use - take/2.

-

Example:

- -> string:span("\t abcdef", " \t"). -5 - - - - - - Find the index of a substring. - -

Returns the position where the first occurrence of - SubString begins in String. - Returns 0 if SubString - does not exist in String.

-

This function is obsolete. - Use - find/2.

-

Example:

- -> string:str(" Hello Hello World World ", "Hello World"). -8 - - - - - - - - Strip leading or trailing characters. - -

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

-

This function is obsolete. - Use - trim/3.

-

Example:

- -> string:strip("...Hello.....", both, $.). -"Hello" - - - - - - - Extract a substring. - -

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

-

This function is obsolete. - Use - slice/3.

-

Example:

- -sub_string("Hello World", 4, 8). -"lo Wo" - - - - - - - Return a substring of a string. - -

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

-

This function is obsolete. - Use - slice/3.

-

Example:

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

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

-

This function is obsolete. - Use - nth_lexeme/3.

-

Example:

- -> string:sub_word(" Hello old boy !",3,$o). -"ld b" - - - - - - - - - Convert case of string (ISO/IEC 8859-1). - - - - - -

The specified string or character is case-converted. Notice that - the supported character set is ISO/IEC 8859-1 (also called Latin 1); - all values outside this set are unchanged

-

This function is obsolete use - lowercase/1, - uppercase/1, - titlecase/1 or - casefold/1.

- - - - - - Split string into tokens. - -

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

-

Example:

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

Notice that, as shown in this example, two or more - adjacent separator characters in String - are treated as one. That is, there are no empty - strings in the resulting list of tokens.

-

This function is obsolete. - Use - lexemes/2.

- - - - - - - Count blank separated words. - -

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

-

This function is obsolete. - Use - lexemes/2.

-

Example:

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

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

-
- -- cgit v1.2.3