Str represents a sequence of Unicode characters.
Slots
- allSource
-
Bool all(|Int, Int -> Bool| c)
Return true if c returns true for all of the characters in this string. If this string is empty, return true.
Example:
"Bar".all |Int c->Bool| { return c.isUpper } => false "BAR".any |Int c->Bool| { return c.isUpper } => true
- anySource
-
Bool any(|Int, Int -> Bool| c)
Return true if c returns true for any of the characters in this string. If this string is empty, return false.
Example:
"Foo".any |Int c->Bool| { return c.isUpper } => true "foo".any |Int c->Bool| { return c.isUpper } => false
- capitalizeSource
-
Str capitalize()
Return this string with the first character converted uppercase. The case conversion is for ASCII only. Also see decapitalize and localeCapitalize.
Example:
"foo".capitalize => "Foo"
- compareSource
-
Overrides sys::Obj.compare
Compare based on Unicode character values. Case is not not taken into account - also see compareIgnoreCase and localeCompare.
Examples:
"a".compare("b") => -1 "hi".compare("hi") => 0 "hi".compare("HI") => 1 "b".compare("a") => 1
- compareIgnoreCaseSource
-
Compare two strings without regard to case and return -1, 0, or 1 if this string is less than, equal to, or greater than the specified string. Only ASCII character case is taken into account. See localeCompare for localized case insensitive comparisions.
Examples:
"a".compareIgnoreCase("b") => -1 "hi".compareIgnoreCase("HI") => 0 "b".compareIgnoreCase("a") => 1
- containsSource
-
Return if this string contains the specified string. Convenience for index(s) != null
- containsCharSource
-
Return if this string contains the specified character.
- decapitalizeSource
-
Str decapitalize()
Return this string with the first character converted lowercase. The case conversion is for ASCII only. Also see capitalize and localeDecapitalize.
Example:
"Foo".decapitalize => "foo"
- defValSource
-
static Str defVal
Default value is "".
- eachSource
-
Call the specified function for every char in the starting with index 0 and incrementing up to size-1. This method is idempotent.
Example:
"abc".each |Int c| { echo(c.toChar) }
- eachrSource
-
Reverse each - call the specified function for every char in the string starting with index size-1 and decrementing down to 0. This method is idempotent.
Example:
"abc".eachr |Int c| { echo(c.toChar) }
- endsWithSource
-
Return if this Str ends with the specified Str.
- equalsSource
-
override Bool equals(Obj? obj)
Overrides sys::Obj.equals
Return true if a Str with exact same char sequence.
- equalsIgnoreCaseSource
-
Convenience for
compareIgnoreCase(s) == 0
. Only ASCII character case is taken into account. See localeCompare for localized case insensitive comparisions. - fromDisplayNameSource
-
Str fromDisplayName()
Translate a display name like "Foo Bar" to a programmatic name "fooBar". This method decapitalizes the first letter, then walks the string removing spaces. Also see toDisplayName.
Examples:
"Foo".fromDisplayName -> "foo" "Foo Bar".fromDisplayName -> "fooBar" "Foo Bar Baz".fromDisplayName -> "fooBarBaz" "Foo 33 Bar".fromDisplayName -> "foo33Bar" "Foo XML".fromDisplayName -> "fooXML" "foo bar".fromDisplayName -> "fooBar"
- getSource
-
Get the character at the zero based index as a Unicode code point. Negative indexes may be used to access from the end of the string. This method is accessed via the [] operator.
- hashSource
-
override Int hash()
Overrides sys::Obj.hash
The hash for a Str is platform dependent.
- inSource
-
InStream in()
Create an input stream to read characters from the this string. If binary reads are made from the string, then each character is read as a one byte ASCII char.
- indexSource
-
Int? index(Str s, Int offset := 0)
Return the first occurance of the specified substring searching forward, starting at the specified offset index. A negative offset may be used to access from the end of string. Return null if no occurences are found.
Examples:
"abcabc".index("b") => 1 "abcabc".index("b", 1) => 1 "abcabc".index("b", 3) => 4 "abcabc".index("b", -3) => 4 "abcabc".index("x") => null
- indexIgnoreCaseSource
-
Int? indexIgnoreCase(Str s, Int offset := 0)
Find the index just like index, but ignoring case for ASCII chars only.
- indexrSource
-
Int? indexr(Str s, Int offset := -1)
Reverse index - return the first occurance of the specified substring searching backward, starting at the specified offset index. A negative offset may be used to access from the end of string. Return null if no occurences are found.
Examples:
"abcabc".indexr("b") => 4 "abcabc".indexr("b", -3) => 1 "abcabc".indexr("b", 0) => null
- indexrIgnoreCaseSource
-
Int? indexrIgnoreCase(Str s, Int offset := -1)
Find the index just like indexr, but ignoring case for ASCII chars only.
- internSource
-
Str intern()
Internalize this Str such that two strings which are equal via the
==
operator will have the same reference such that===
will be true. - isAlphaSource
-
Bool isAlpha()
Return if every char is an ASCII
letter
. - isAlphaNumSource
-
Bool isAlphaNum()
Return if every char is an ASCII
alpha-numeric
. - isAsciiSource
-
Bool isAscii()
Return if every character in this Str is a US-ASCII character less than 128.
- isEmptySource
-
Bool isEmpty()
Return if
size() == 0
. - isLowerSource
-
Bool isLower()
Return if every character in this Str is ASCII lowercase:
a
-'z'. - isSpaceSource
-
Bool isSpace()
Return if every character in this Str is whitespace: space \t \n \r \f
- isUpperSource
-
Bool isUpper()
Return if every character in this Str is ASCII uppercase:
A
-'Z'. - justlSource
-
If size is less than width, then add spaces to the right to create a left justified string. Also see padr.
Examples:
"xyz".justl(2) => "xyz" "xyz".justl(4) => "xyz "
- justrSource
-
If size is less than width, then add spaces to the left to create a right justified string. Also see padl.
Examples:
"xyz".justr(2) => "xyz" "xyz".justr(4) => " xyz"
- localeCapitalizeSource
-
Str localeCapitalize()
Return this string with the first character converted to uppercase using the current locale. Also see localeDecapitalize and capitalize.
- localeCompareSource
-
Compare two strings without regard to case according to the current locale. Return -1, 0, or 1 if this string is less than, equal to, or greater than the specified string.
Examples (assuming English locale):
"a".localeCompare("b") => -1 "hi".localeCompare("HI") => 0 "b".localeCompare("A") => 1
- localeDecapitalizeSource
-
Str localeDecapitalize()
Return this string with the first character converted to lowercase using the current locale. Also see localeCapitalize and decapitalize.
- localeLowerSource
-
Str localeLower()
Return this string with all uppercase characters replaced to lowercase using the current locale. Also see localeUpper, lower, and
Int.localeLower
. - localeUpperSource
-
Str localeUpper()
Return this string with all lowercase characters replaced to uppercase using the current locale. Also see localeLower, upper, and
Int.localeUpper
. - lowerSource
-
Str lower()
Return this string with all uppercase characters replaced to lowercase. The case conversion is for ASCII only. Also see upper, localeLower,
Int.lower
,Int.localeLower
.Example:
"Apple".lower => "apple"
- numNewlinesSource
-
Int numNewlines()
Count the number of newline combinations: "\n", "\r", or "\r\n".
- padlSource
-
Str padl(Int width, Int char := 32)
If size is less than width, then add the given char to the left to achieve the specified width. Also see justr.
Examples:
"3".padl(3, '0') => "003" "123".padl(2, '0') => "123"
- padrSource
-
Str padr(Int width, Int char := 32)
If size is less than width, then add the given char to the left to acheive the specified with. Also see justl.
Examples:
"xyz".padr(2, '.') => "xyz" "xyz".padr(5, '-') => "xyz--"
- plusSource
-
Concat the value of obj.toStr
-
new privateMake()
Private constructor.
- replaceSource
-
Replace all occurrences of
from
withto
.Examples:
"hello".replace("hell", "t") => "to" "aababa".replace("ab", "-") => "a--a"
- reverseSource
-
Str reverse()
Reverse the contents of this string.
Example:
"stressed".reverse => "desserts"
- sizeSource
-
Int size()
Return number of characters in this string.
- sliceSource
-
Return a substring based on the specified range. Negative indexes may be used to access from the end of the string. This method is accessed via the [] operator. Throw IndexErr if range illegal.
Examples:
"abcd"[0..2] => "abc" "abcd"[3..3] => "d" "abcd"[-2..-1] => "cd" "abcd"[0..<2] => "ab" "abcd"[1..-2] => "bc" "abcd"[4..-1] => ""
- spacesSource
-
Get the a Str containing the specified number of spaces. Also see justl and justr to justify an existing string.
Examples:
Str.spaces(1) => " " Str.spaces(2) => " "
- splitSource
-
Str[] split(Int? separator := null, Bool trim := true)
Split a string into a list of substrings using the given separator character. If there are contiguous separators, then they are split into empty strings. If trim is true, then whitespace is trimmed from the beginning and end of the results.
If separator is null, then the string is split according to any sequence of whitespace characters (any character equal to or less than the 0x20 space character including
\r
,\n
, and\t
).If this is the empty string or there are no splits return a list of one item.
Examples:
// split on whitespace "".split => [""] "x".split => ["x"] "x y".split => ["x", "y"] " x y ".split => ["x", "y"] " x \n y \n z ".split => ["x", "y", "z"] // split on sep with trim "".split('|') => [""] "22".split(';') => ["22"] "22;33".split(';') => ["22","33"] "22, 33".split(',') => ["22","33"] " 22 ; 33 ".split(';') => ["22","33"] // split on sep with no trim "22#33".split('#', false) => ["22","33"] " x ; y".split(';', false) => [" x "," y"]
- splitLinesSource
-
Str[] splitLines()
Split this string into individual lines where lines are terminated by \n, \r\n, or \r. The returned strings do not contain the newline character.
Examples:
"x\ny".splitLines => ["x", "y"] "".splitLines => [""] "x".splitLines => ["x"] "\r\n".splitLines => ["", ""] "x\n".splitLines => ["x", ""]
- startsWithSource
-
Return if this Str starts with the specified Str.
- toBoolSource
-
Bool? toBool(Bool checked := true)
Convenience for
Bool.fromStr
using this string. - toBufSource
-
Buf toBuf(Charset charset := Charset.utf8())
Get this string encoded into a buffer of bytes.
- toCodeSource
-
Str toCode(Int? quote := (Int?)34, Bool escapeUnicode := false)
Return this string as its Fan source code and serialization representation surrounded by the specified quote character (which defaults to
"
). If quote is null then the return is unquoted. This method will backslash escape the following characters:\n \r \f \t \\ $
. If the quote character is the double quote, single quote, or backtick then it is escaped too. IfescapeUnicode
is true then any character over 127 is also escaped as\uXXXX
. - toDecimalSource
-
Decimal? toDecimal(Bool checked := true)
Convenience for
Decimal.fromStr
using this string. - toDisplayNameSource
-
Str toDisplayName()
Translate a programmer name like "fooBar" to "Foo Bar". This method capitalizes the first letter, then walks the string looking for ASCII capital letters and inserting a space. Any underbars are replaced with a space. Also see fromDisplayName.
Examples:
"foo".toDisplayName -> "Foo "fooBar".toDisplayName -> "Foo Bar" "fooBarBaz".toDisplayName -> "Foo Bar Baz" "foo33".toDisplayName -> "Foo 33" "fooXML".toDisplayName -> "Foo XML" "Foo".toDisplayName -> "Foo" "foo_bar".toDisplayName -> "Foo Bar"
- toFloatSource
-
Float? toFloat(Bool checked := true)
Convenience for
Float.fromStr
using this string. - toIntSource
-
Int? toInt(Int radix := 10, Bool checked := true)
Convenience for
Int.fromStr
using this string. - toLocaleSource
-
Str toLocale()
Return this. This method is used to enable
toLocale
to be used with duck typing across most built-in types. - toStrSource
-
override Str toStr()
Overrides sys::Obj.toStr
Return this.
- toUriSource
-
Uri toUri()
Convenience for
Uri.fromStr
using this string. - toXmlSource
-
Str toXml()
Return this string as valid XML text. The special control characters amp, lt, apos and quot are always escaped. The gt char is escaped only if it is the first char or if preceeded by the
]
char. Also seeOutStream.writeXml
which is more efficient if streaming. - trimSource
-
Str trim()
Trim whitespace from the beginning and end of the string. For the purposes of this method, whitespace is defined as any character equal to or less than the 0x20 space character (including
\r
,\n
, and\t
).Examples:
"foo".trim => "foo" " foo".trim => "foo" " foo ".trim => "foo" " foo\n".trim => "foo" " ".trim => ""
- trimEndSource
-
Str trimEnd()
Trim whitespace only from the end of the string. See trim for definition of whitespace.
Examples:
"foo".trim => "foo" " foo ".trim => " foo"
- trimStartSource
-
Str trimStart()
Trim whitespace only from the beginning of the string. See trim for definition of whitespace.
Examples:
"foo".trim => "foo" " foo ".trim => "foo "
- upperSource
-
Str upper()
Return this string with all lowercase characters replaced to uppercase. The case conversion is for ASCII only. Also see lower, localeUpper,
Int.upper
,Int.localeUpper
.Example:
"Foo Bar".upper => "FOO BAR"