An alias for toUTF8.

See also:

• validateUtf8 proc
• fastToUTF8Copy template

Converts a sequence of Runes to a string.

See also:

• toRunes for a reverse operation

Example:

let
  someString = "öÑ"
  someRunes = toRunes(someString)
doAssert $someRunes == someString

Example:

let
  a = "ú".runeAt(0)
  b = "ü".runeAt(0)
doAssert a <% b

Example:

let
  a = "ú".runeAt(0)
  b = "ü".runeAt(0)
doAssert a <=% b

Example:

var s = "abc"
let c = "ä".runeAt(0)
s.add(c)
doAssert s == "abcä"

Aligns a unicode string s with padding, so that it has a rune-length of count.

padding characters (by default spaces) are added before s resulting in right alignment. If s.runelen >= count, no spaces are added and s is returned unchanged. If you need to left align a string use the alignLeft proc.

Example:

assert align("abc", 4) == " abc"
assert align("a", 0) == "a"
assert align("1232", 6) == "  1232"
assert align("1232", 6, '#'.Rune) == "##1232"
assert align("Åge", 5) == "  Åge"
assert align("×", 4, '_'.Rune) == "___×"

Aligns a unicode string s with padding, so that it has a rune-length of count.

padding characters (by default spaces) are added before s resulting in right alignment. If s.runelen >= count, no spaces are added and s is returned unchanged. If you need to left align a string use the alignLeft proc.

Example:

assert align("abc", 4) == " abc"
assert align("a", 0) == "a"
assert align("1232", 6) == "  1232"
assert align("1232", 6, '#'.Rune) == "##1232"
assert align("Åge", 5) == "  Åge"
assert align("×", 4, '_'.Rune) == "___×"

Left-aligns a unicode string s with padding, so that it has a rune-length of count.

padding characters (by default spaces) are added after s resulting in left alignment. If s.runelen >= count, no spaces are added and s is returned unchanged. If you need to right align a string use the align proc.

Example:

assert alignLeft("abc", 4) == "abc "
assert alignLeft("a", 0) == "a"
assert alignLeft("1232", 6) == "1232  "
assert alignLeft("1232", 6, '#'.Rune) == "1232##"
assert alignLeft("Åge", 5) == "Åge  "
assert alignLeft("×", 4, '_'.Rune) == "×___"

Left-aligns a unicode string s with padding, so that it has a rune-length of count.

padding characters (by default spaces) are added after s resulting in left alignment. If s.runelen >= count, no spaces are added and s is returned unchanged. If you need to right align a string use the align proc.

Example:

assert alignLeft("abc", 4) == "abc "
assert alignLeft("a", 0) == "a"
assert alignLeft("1232", 6) == "1232  "
assert alignLeft("1232", 6, '#'.Rune) == "1232##"
assert alignLeft("Åge", 5) == "Åge  "
assert alignLeft("×", 4, '_'.Rune) == "×___"

Example:

doAssert capitalize("βeta") == "Βeta"

Example:

doAssert capitalize("βeta") == "Βeta"

0 if a == b
< 0 if a < b
> 0 if a > b

0 if a == b
< 0 if a < b
> 0 if a > b

Example:

let a = "añyóng"
doAssert a.graphemeLen(1) == 2 ## ñ
doAssert a.graphemeLen(2) == 1
doAssert a.graphemeLen(4) == 2 ## ó

Example:

let a = "añyóng"
doAssert a.graphemeLen(1) == 2 ## ñ
doAssert a.graphemeLen(2) == 1
doAssert a.graphemeLen(4) == 2 ## ó

Returns true if c is an alpha rune (i.e., a letter).

See also:

• isLower proc
• isTitle proc
• isAlpha proc
• isWhiteSpace proc
• isCombining proc

Example:

let a = "añyóng"
doAssert a.isAlpha

Example:

let a = "añyóng"
doAssert a.isAlpha

Returns true if c is a Unicode combining code unit.

See also:

• isLower proc
• isUpper proc
• isTitle proc
• isAlpha proc

Returns true if c is a lower case rune.

If possible, prefer isLower over isUpper.

See also:

• toLower proc
• isUpper proc
• isTitle proc

Example:

let a = "\t\l \v\r\f"
doAssert a.isSpace

Example:

let a = "\t\l \v\r\f"
doAssert a.isSpace

Returns true if c is a Unicode titlecase code point.

See also:

• toTitle proc
• isLower proc
• isUpper proc
• isAlpha proc
• isWhiteSpace proc

Returns true if c is a upper case rune.

If possible, prefer isLower over isUpper.

See also:

• toUpper proc
• isLower proc
• isTitle proc
• isAlpha proc
• isWhiteSpace proc

Returns true if c is a Unicode whitespace code point.

See also:

• isLower proc
• isUpper proc
• isTitle proc
• isAlpha proc

Returns a string of count Runes c.

The returned string will have a rune-length of count.

Example:

let a = "ñ".runeAt(0)
doAssert a.repeat(5) == "ñññññ"

Returns the reverse of s, interpreting it as runes.

Unicode combining characters are correctly interpreted as well.

Example:

assert reversed("Reverse this!") == "!siht esreveR"
assert reversed("先秦兩漢") == "漢兩秦先"
assert reversed("as⃝df̅") == "f̅ds⃝a"
assert reversed("a⃞b⃞c⃞") == "c⃞b⃞a⃞"

Returns the reverse of s, interpreting it as runes.

Unicode combining characters are correctly interpreted as well.

Example:

assert reversed("Reverse this!") == "!siht esreveR"
assert reversed("先秦兩漢") == "漢兩秦先"
assert reversed("as⃝df̅") == "f̅ds⃝a"
assert reversed("a⃞b⃞c⃞") == "c⃞b⃞a⃞"

Returns the rune in s at byte index i.

See also:

• runeAtPos proc
• runeStrAtPos proc
• fastRuneAt template

Example:

let a = "añyóng"
doAssert a.runeAt(1) == "ñ".runeAt(0)
doAssert a.runeAt(2) == "ñ".runeAt(1)
doAssert a.runeAt(3) == "y".runeAt(0)

Returns the rune in s at byte index i.

See also:

• runeAtPos proc
• runeStrAtPos proc
• fastRuneAt template

Example:

let a = "añyóng"
doAssert a.runeAt(1) == "ñ".runeAt(0)
doAssert a.runeAt(2) == "ñ".runeAt(1)
doAssert a.runeAt(3) == "y".runeAt(0)

Returns the rune at position pos.

Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.

See also:

• runeAt proc
• runeStrAtPos proc
• fastRuneAt template

Returns the rune at position pos.

Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.

See also:

• runeAt proc
• runeStrAtPos proc
• fastRuneAt template

Example:

let a = "añyóng"
doAssert a.runeLen == 6
## note: a.len == 8

Example:

let a = "añyóng"
doAssert a.runeLen == 6
## note: a.len == 8

Returns the number of bytes the rune starting at s[i] takes.

See also:

• fastRuneAt template

Example:

let a = "añyóng"
doAssert a.runeLenAt(0) == 1
doAssert a.runeLenAt(1) == 2

Returns the number of bytes the rune starting at s[i] takes.

See also:

• fastRuneAt template

Example:

let a = "añyóng"
doAssert a.runeLenAt(0) == 1
doAssert a.runeLenAt(1) == 2

Returns the byte position of rune at position pos in s with an optional start byte position. Returns the special value -1 if it runs out of the string.

Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.

See also:

• runeReverseOffset proc

Example:

let a = "añyóng"
doAssert a.runeOffset(1) == 1
doAssert a.runeOffset(3) == 4
doAssert a.runeOffset(4) == 6

Returns the byte position of rune at position pos in s with an optional start byte position. Returns the special value -1 if it runs out of the string.

Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.

See also:

• runeReverseOffset proc

Example:

let a = "añyóng"
doAssert a.runeOffset(1) == 1
doAssert a.runeOffset(3) == 4
doAssert a.runeOffset(4) == 6

Returns a tuple with the byte offset of the rune at position rev in s, counting from the end (starting with 1) and the total number of runes in the string.

Returns a negative value for offset if there are too few runes in the string to satisfy the request.

Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.

See also:

• runeOffset proc

Returns a tuple with the byte offset of the rune at position rev in s, counting from the end (starting with 1) and the total number of runes in the string.

Returns a negative value for offset if there are too few runes in the string to satisfy the request.

Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.

See also:

• runeOffset proc

Returns the rune at position pos as UTF8 String.

Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.

See also:

• runeAt proc
• runeAtPos proc
• fastRuneAt template

Returns the rune at position pos as UTF8 String.

Beware: This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.

See also:

• runeAt proc
• runeAtPos proc
• fastRuneAt template

Returns the UTF-8 substring starting at code point pos with len code points.

If pos or len is negative they count from the end of the string. If len is not given it means the longest possible string.

Example:

let s = "Hänsel  ««: 10,00€"
doAssert(runeSubStr(s, 0, 2) == "Hä")
doAssert(runeSubStr(s, 10, 1) == ":")
doAssert(runeSubStr(s, -6) == "10,00€")
doAssert(runeSubStr(s, 10) == ": 10,00€")
doAssert(runeSubStr(s, 12, 5) == "10,00")
doAssert(runeSubStr(s, -6, 3) == "10,")

Returns the UTF-8 substring starting at code point pos with len code points.

If pos or len is negative they count from the end of the string. If len is not given it means the longest possible string.

Example:

let s = "Hänsel  ««: 10,00€"
doAssert(runeSubStr(s, 0, 2) == "Hä")
doAssert(runeSubStr(s, 10, 1) == ":")
doAssert(runeSubStr(s, -6) == "10,00€")
doAssert(runeSubStr(s, 10) == ": 10,00€")
doAssert(runeSubStr(s, 12, 5) == "10,00")
doAssert(runeSubStr(s, -6, 3) == "10,")

Example:

let a = toRunes "aá"
doAssert size(a[0]) == 1
doAssert size(a[1]) == 2

Strips leading or trailing runes from s and returns the resulting string.

If leading is true (default), leading runes are stripped. If trailing is true (default), trailing runes are stripped. If both are false, the string is returned unchanged.

Example:

let a = "\táñyóng   "
doAssert a.strip == "áñyóng"
doAssert a.strip(leading = false) == "\táñyóng"
doAssert a.strip(trailing = false) == "áñyóng   "

Strips leading or trailing runes from s and returns the resulting string.

If leading is true (default), leading runes are stripped. If trailing is true (default), trailing runes are stripped. If both are false, the string is returned unchanged.

Example:

let a = "\táñyóng   "
doAssert a.strip == "áñyóng"
doAssert a.strip(leading = false) == "\táñyóng"
doAssert a.strip(trailing = false) == "áñyóng   "

Swaps the case of runes in s.

Returns a new string such that the cases of all runes are swapped if possible.

Example:

doAssert swapCase("Αlpha Βeta Γamma") == "αLPHA βETA γAMMA"

Swaps the case of runes in s.

Returns a new string such that the cases of all runes are swapped if possible.

Example:

doAssert swapCase("Αlpha Βeta Γamma") == "αLPHA βETA γAMMA"

Converts s to a unicode title.

Returns a new string such that the first character in each word inside s is capitalized.

Example:

doAssert title("αlpha βeta γamma") == "Αlpha Βeta Γamma"

Converts s to a unicode title.

Returns a new string such that the first character in each word inside s is capitalized.

Example:

doAssert title("αlpha βeta γamma") == "Αlpha Βeta Γamma"

Converts c into lower case. This works for any rune.

If possible, prefer toLower over toUpper.

See also:

• toUpper proc
• toTitle proc
• isLower proc

Example:

doAssert toLower("ABΓ") == "abγ"

Example:

doAssert toLower("ABΓ") == "abγ"

Obtains a sequence containing the Runes in s.

See also:

• $ proc for a reverse operation

Example:

let a = toRunes("aáä")
doAssert a == @["a".runeAt(0), "á".runeAt(0), "ä".runeAt(0)]

Obtains a sequence containing the Runes in s.

See also:

• $ proc for a reverse operation

Example:

let a = toRunes("aáä")
doAssert a == @["a".runeAt(0), "á".runeAt(0), "ä".runeAt(0)]

Converts c to title case.

See also:

• toLower proc
• toUpper proc
• isTitle proc

Converts c into upper case. This works for any rune.

If possible, prefer toLower over toUpper.

See also:

• toLower proc
• toTitle proc
• isUpper proc

Example:

doAssert toUpper("abγ") == "ABΓ"

Example:

doAssert toUpper("abγ") == "ABΓ"

Converts a rune into its UTF-8 representation.

See also:

• validateUtf8 proc
• $ proc alias for toUTF8
• utf8 iterator
• fastToUTF8Copy template

Example:

let a = "añyóng"
doAssert a.runeAt(1).toUTF8 == "ñ"

Translates words in a string using the replacements proc to substitute words inside s with their replacements.

replacements is any proc that takes a word and returns a new word to fill it's place.

Example:

proc wordToNumber(s: string): string =
  case s
  of "one": "1"
  of "two": "2"
  else: s
let a = "one two three four"
doAssert a.translate(wordToNumber) == "1 2 three four"

Translates words in a string using the replacements proc to substitute words inside s with their replacements.

replacements is any proc that takes a word and returns a new word to fill it's place.

Example:

proc wordToNumber(s: string): string =
  case s
  of "one": "1"
  of "two": "2"
  else: s
let a = "one two three four"
doAssert a.translate(wordToNumber) == "1 2 three four"

Returns the position of the invalid byte in s if the string s does not hold valid UTF-8 data. Otherwise -1 is returned.

See also:

• toUTF8 proc
• $ proc alias for toUTF8
• fastToUTF8Copy template

Returns the position of the invalid byte in s if the string s does not hold valid UTF-8 data. Otherwise -1 is returned.

See also:

• toUTF8 proc
• $ proc alias for toUTF8
• fastToUTF8Copy template

Example:

import std/sequtils

assert toSeq(split(";;hÃllo;this;is;an;;example;;;是", ";".runeAt(0))) ==
  @["", "", "hÃllo", "this", "is", "an", "", "example", "", "", "是"]

Splits the unicode string s into substrings using a group of separators.

Substrings are separated by a substring containing only seps.

Example:

import std/sequtils

assert toSeq("hÃllo\lthis\lis an\texample\l是".split) ==
  @["hÃllo", "this", "is", "an", "example", "是"]

# And the following code splits the same string using a sequence of Runes.
assert toSeq(split("añyóng:hÃllo;是$example", ";:$".toRunes)) ==
  @["añyóng", "hÃllo", "是", "example"]

# example with a `Rune` separator and unused one `;`:
assert toSeq(split("ab是de:f:", ";:是".toRunes)) == @["ab", "de", "f", ""]

# Another example that splits a string containing a date.
let date = "2012-11-20T22:08:08.398990"

assert toSeq(split(date, " -:T".toRunes)) ==
  @["2012", "11", "20", "22", "08", "08.398990"]

Example:

import std/sequtils

assert toSeq(split(";;hÃllo;this;is;an;;example;;;是", ";".runeAt(0))) ==
  @["", "", "hÃllo", "this", "is", "an", "", "example", "", "", "是"]

Splits the unicode string s into substrings using a group of separators.

Substrings are separated by a substring containing only seps.

Example:

import std/sequtils

assert toSeq("hÃllo\lthis\lis an\texample\l是".split) ==
  @["hÃllo", "this", "is", "an", "example", "是"]

# And the following code splits the same string using a sequence of Runes.
assert toSeq(split("añyóng:hÃllo;是$example", ";:$".toRunes)) ==
  @["añyóng", "hÃllo", "是", "example"]

# example with a `Rune` separator and unused one `;`:
assert toSeq(split("ab是de:f:", ";:是".toRunes)) == @["ab", "de", "f", ""]

# Another example that splits a string containing a date.
let date = "2012-11-20T22:08:08.398990"

assert toSeq(split(date, " -:T".toRunes)) ==
  @["2012", "11", "20", "22", "08", "08.398990"]

Iterates over any rune of the string s returning utf8 values.

See also:

• validateUtf8 proc
• toUTF8 proc
• $ proc alias for toUTF8
• fastToUTF8Copy template

Iterates over any rune of the string s returning utf8 values.

See also:

• validateUtf8 proc
• toUTF8 proc
• $ proc alias for toUTF8
• fastToUTF8Copy template

Returns the rune s[i] in result.

If doInc == true (default), i is incremented by the number of bytes that have been processed.

Copies UTF-8 representation of c into the preallocated string s starting at position pos.

If doInc == true (default), pos is incremented by the number of bytes that have been processed.

To be the most efficient, make sure s is preallocated with an additional amount equal to the byte length of c.

See also:

• validateUtf8 proc
• toUTF8 proc
• $ proc alias for toUTF8