Package strings implements simple functions to manipulate UTF-8 encoded strings.

For information about UTF-8 strings in Go, see https://blog.golang.org/strings.

Static methods

staticinlineclone(_s:GoString):GoString

Clone returns a fresh copy of s. It guarantees to make a copy of s into a new allocation, which can be important when retaining only a small substring of a much larger string. Using Clone can help such programs use less memory. Of course, since using Clone makes a copy, overuse of Clone can make programs use more memory. Clone should typically be used only rarely, and only when profiling indicates that it is needed. For strings of length zero the string "" will be returned and no allocation is made.

See also:

staticinlinecompare(_a:GoString, _b:GoString):GoInt

Compare returns an integer comparing two strings lexicographically. The result will be 0 if a == b, -1 if a < b, and +1 if a > b.

Compare is included only for symmetry with package bytes. It is usually clearer and always faster to use the built-in string comparison operators ==, <, >, and so on.

See also:

staticinlinecontains(_s:GoString, _substr:GoString):Bool

Contains reports whether substr is within s.

See also:

staticinlinecontainsAny(_s:GoString, _chars:GoString):Bool

ContainsAny reports whether any Unicode code points in chars are within s.

See also:

staticinlinecontainsFunc(_s:GoString, _f:GoInt32 ‑> Bool):Bool

ContainsFunc reports whether any Unicode code points r within s satisfy f(r).

See also:

staticinlinecontainsRune(_s:GoString, _r:GoInt32):Bool

ContainsRune reports whether the Unicode code point r is within s.

See also:

staticinlinecount(_s:GoString, _substr:GoString):GoInt

Count counts the number of non-overlapping instances of substr in s. If substr is an empty string, Count returns 1 + the number of Unicode code points in s.

See also:

staticinlinecut(_s:GoString, _sep:GoString):{_2:Bool, _1:GoString, _0:GoString}

Cut slices s around the first instance of sep, returning the text before and after sep. The found result reports whether sep appears in s. If sep does not appear in s, cut returns s, "", false.

See also:

staticinlinecutPrefix(_s:GoString, _prefix:GoString):{_1:Bool, _0:GoString}

CutPrefix returns s without the provided leading prefix string and reports whether it found the prefix. If s doesn't start with prefix, CutPrefix returns s, false. If prefix is the empty string, CutPrefix returns s, true.

See also:

staticinlinecutSuffix(_s:GoString, _suffix:GoString):{_1:Bool, _0:GoString}

CutSuffix returns s without the provided ending suffix string and reports whether it found the suffix. If s doesn't end with suffix, CutSuffix returns s, false. If suffix is the empty string, CutSuffix returns s, true.

See also:

staticinlineequalFold(_s:GoString, _t:GoString):Bool

EqualFold reports whether s and t, interpreted as UTF-8 strings, are equal under simple Unicode case-folding, which is a more general form of case-insensitivity.

See also:

staticinlinefields(_s:GoString):Slice<GoString>

Fields splits the string s around each instance of one or more consecutive white space characters, as defined by unicode.IsSpace, returning a slice of substrings of s or an empty slice if s contains only white space.

See also:

staticinlinefieldsFunc(_s:GoString, _f:GoInt32 ‑> Bool):Slice<GoString>

FieldsFunc splits the string s at each run of Unicode code points c satisfying f(c) and returns an array of slices of s. If all code points in s satisfy f(c) or the string is empty, an empty slice is returned.

FieldsFunc makes no guarantees about the order in which it calls f(c) and assumes that f always returns the same value for a given c.

See also:

staticinlinehasPrefix(_s:GoString, _prefix:GoString):Bool

HasPrefix tests whether the string s begins with prefix.

See also:

staticinlinehasSuffix(_s:GoString, _suffix:GoString):Bool

HasSuffix tests whether the string s ends with suffix.

See also:

staticinlineindex(_s:GoString, _substr:GoString):GoInt

Index returns the index of the first instance of substr in s, or -1 if substr is not present in s.

See also:

staticinlineindexAny(_s:GoString, _chars:GoString):GoInt

IndexAny returns the index of the first instance of any Unicode code point from chars in s, or -1 if no Unicode code point from chars is present in s.

See also:

staticinlineindexByte(_s:GoString, _c:GoUInt8):GoInt

IndexByte returns the index of the first instance of c in s, or -1 if c is not present in s.

See also:

staticinlineindexFunc(_s:GoString, _f:GoInt32 ‑> Bool):GoInt

IndexFunc returns the index into s of the first Unicode code point satisfying f(c), or -1 if none do.

See also:

staticinlineindexRune(_s:GoString, _r:GoInt32):GoInt

IndexRune returns the index of the first instance of the Unicode code point r, or -1 if rune is not present in s. If r is utf8.RuneError, it returns the first instance of any invalid UTF-8 byte sequence.

See also:

staticinlinejoin(_elems:Slice<GoString>, _sep:GoString):GoString

Join concatenates the elements of its first argument to create a single string. The separator string sep is placed between elements in the resulting string.

See also:

staticinlinelastIndex(_s:GoString, _substr:GoString):GoInt

LastIndex returns the index of the last instance of substr in s, or -1 if substr is not present in s.

See also:

staticinlinelastIndexAny(_s:GoString, _chars:GoString):GoInt

LastIndexAny returns the index of the last instance of any Unicode code point from chars in s, or -1 if no Unicode code point from chars is present in s.

See also:

staticinlinelastIndexByte(_s:GoString, _c:GoUInt8):GoInt

LastIndexByte returns the index of the last instance of c in s, or -1 if c is not present in s.

See also:

staticinlinelastIndexFunc(_s:GoString, _f:GoInt32 ‑> Bool):GoInt

LastIndexFunc returns the index into s of the last Unicode code point satisfying f(c), or -1 if none do.

See also:

staticinlinemap_(_mapping:GoInt32 ‑> GoInt32, _s:GoString):GoString

Map returns a copy of the string s with all its characters modified according to the mapping function. If mapping returns a negative value, the character is dropped from the string with no replacement.

See also:

staticinlinenewReader(_s:GoString):Ref<Reader>

NewReader returns a new Reader reading from s. It is similar to bytes.NewBufferString but more efficient and non-writable.

See also:

staticinlinenewReplacer(_oldnew:Rest<GoString>):Ref<Replacer>

NewReplacer returns a new Replacer from a list of old, new string pairs. Replacements are performed in the order they appear in the target string, without overlapping matches. The old string comparisons are done in argument order.

NewReplacer panics if given an odd number of arguments.

See also:

staticinlinerepeat(_s:GoString, _count:GoInt):GoString

Repeat returns a new string consisting of count copies of the string s.

It panics if count is negative or if the result of (len(s) * count) overflows.

See also:

staticinlinereplace(_s:GoString, _old:GoString, _new_:GoString, _n:GoInt):GoString

Replace returns a copy of the string s with the first n non-overlapping instances of old replaced by new. If old is empty, it matches at the beginning of the string and after each UTF-8 sequence, yielding up to k+1 replacements for a k-rune string. If n < 0, there is no limit on the number of replacements.

See also:

staticinlinereplaceAll(_s:GoString, _old:GoString, _new_:GoString):GoString

ReplaceAll returns a copy of the string s with all non-overlapping instances of old replaced by new. If old is empty, it matches at the beginning of the string and after each UTF-8 sequence, yielding up to k+1 replacements for a k-rune string.

See also:

staticinlinesplit(_s:GoString, _sep:GoString):Slice<GoString>

Split slices s into all substrings separated by sep and returns a slice of the substrings between those separators.

If s does not contain sep and sep is not empty, Split returns a slice of length 1 whose only element is s.

If sep is empty, Split splits after each UTF-8 sequence. If both s and sep are empty, Split returns an empty slice.

It is equivalent to SplitN with a count of -1.

To split around the first instance of a separator, see Cut.

See also:

staticinlinesplitAfter(_s:GoString, _sep:GoString):Slice<GoString>

SplitAfter slices s into all substrings after each instance of sep and returns a slice of those substrings.

If s does not contain sep and sep is not empty, SplitAfter returns a slice of length 1 whose only element is s.

If sep is empty, SplitAfter splits after each UTF-8 sequence. If both s and sep are empty, SplitAfter returns an empty slice.

It is equivalent to SplitAfterN with a count of -1.

See also:

staticinlinesplitAfterN(_s:GoString, _sep:GoString, _n:GoInt):Slice<GoString>

SplitAfterN slices s into substrings after each instance of sep and returns a slice of those substrings.

The count determines the number of substrings to return:

n > 0: at most n substrings; the last substring will be the unsplit remainder.
n == 0: the result is nil (zero substrings)
n < 0: all substrings

Edge cases for s and sep (for example, empty strings) are handled as described in the documentation for SplitAfter.

See also:

staticinlinesplitN(_s:GoString, _sep:GoString, _n:GoInt):Slice<GoString>

SplitN slices s into substrings separated by sep and returns a slice of the substrings between those separators.

The count determines the number of substrings to return:

n > 0: at most n substrings; the last substring will be the unsplit remainder.
n == 0: the result is nil (zero substrings)
n < 0: all substrings

Edge cases for s and sep (for example, empty strings) are handled as described in the documentation for Split.

To split around the first instance of a separator, see Cut.

See also:

staticinlinetitle(_s:GoString):GoString

Title returns a copy of the string s with all Unicode letters that begin words mapped to their Unicode title case.

Deprecated: The rule Title uses for word boundaries does not handle Unicode punctuation properly. Use golang.org/x/text/cases instead.

See also:

staticinlinetoLower(_s:GoString):GoString

ToLower returns s with all Unicode letters mapped to their lower case.

See also:

staticinlinetoLowerSpecial(_c:SpecialCase, _s:GoString):GoString

ToLowerSpecial returns a copy of the string s with all Unicode letters mapped to their lower case using the case mapping specified by c.

See also:

staticinlinetoTitle(_s:GoString):GoString

ToTitle returns a copy of the string s with all Unicode letters mapped to their Unicode title case.

See also:

staticinlinetoTitleSpecial(_c:SpecialCase, _s:GoString):GoString

ToTitleSpecial returns a copy of the string s with all Unicode letters mapped to their Unicode title case, giving priority to the special casing rules.

See also:

staticinlinetoUpper(_s:GoString):GoString

ToUpper returns s with all Unicode letters mapped to their upper case.

See also:

staticinlinetoUpperSpecial(_c:SpecialCase, _s:GoString):GoString

ToUpperSpecial returns a copy of the string s with all Unicode letters mapped to their upper case using the case mapping specified by c.

See also:

staticinlinetoValidUTF8(_s:GoString, _replacement:GoString):GoString

ToValidUTF8 returns a copy of the string s with each run of invalid UTF-8 byte sequences replaced by the replacement string, which may be empty.

See also:

staticinlinetrim(_s:GoString, _cutset:GoString):GoString

Trim returns a slice of the string s with all leading and trailing Unicode code points contained in cutset removed.

See also:

staticinlinetrimFunc(_s:GoString, _f:GoInt32 ‑> Bool):GoString

TrimFunc returns a slice of the string s with all leading and trailing Unicode code points c satisfying f(c) removed.

See also:

staticinlinetrimLeft(_s:GoString, _cutset:GoString):GoString

TrimLeft returns a slice of the string s with all leading Unicode code points contained in cutset removed.

To remove a prefix, use TrimPrefix instead.

See also:

staticinlinetrimLeftFunc(_s:GoString, _f:GoInt32 ‑> Bool):GoString

TrimLeftFunc returns a slice of the string s with all leading Unicode code points c satisfying f(c) removed.

See also:

staticinlinetrimPrefix(_s:GoString, _prefix:GoString):GoString

TrimPrefix returns s without the provided leading prefix string. If s doesn't start with prefix, s is returned unchanged.

See also:

staticinlinetrimRight(_s:GoString, _cutset:GoString):GoString

TrimRight returns a slice of the string s, with all trailing Unicode code points contained in cutset removed.

To remove a suffix, use TrimSuffix instead.

See also:

staticinlinetrimRightFunc(_s:GoString, _f:GoInt32 ‑> Bool):GoString

TrimRightFunc returns a slice of the string s with all trailing Unicode code points c satisfying f(c) removed.

See also:

staticinlinetrimSpace(_s:GoString):GoString

TrimSpace returns a slice of the string s, with all leading and trailing white space removed, as defined by Unicode.

See also:

staticinlinetrimSuffix(_s:GoString, _suffix:GoString):GoString

TrimSuffix returns s without the provided trailing suffix string. If s doesn't end with suffix, s is returned unchanged.

See also: