strings

func Clone ¶

func Clone(s string) string

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.

This is an alias of https://pkg.go.dev/strings#Clone.

func Compare ¶

func Compare(a, b string) int

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.

Use Compare when you need to perform a three-way comparison (with slices.SortFunc, for example). It is usually clearer and always faster to use the built-in string comparison operators ==, <, >, and so on.

This is an alias of https://pkg.go.dev/strings#Compare.

func Contains ¶

func Contains(s, substr string) bool

Contains reports whether substr is within s.

This is an alias of https://pkg.go.dev/strings#Contains.

func ContainsAny ¶

func ContainsAny(s, chars string) bool

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

This is an alias of https://pkg.go.dev/strings#ContainsAny.

func ContainsFunc ¶

func ContainsFunc(s string, f func(rune) bool) bool

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

This is an alias of https://pkg.go.dev/strings#ContainsFunc.

func ContainsRune ¶

func ContainsRune(s string, r rune) bool

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

This is an alias of https://pkg.go.dev/strings#ContainsRune.

func Count ¶

func Count(s, substr string) int

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.

This is an alias of https://pkg.go.dev/strings#Count.

func Cut ¶

func Cut(s, sep string) (before, after string, found bool)

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.

This is an alias of https://pkg.go.dev/strings#Cut.

func CutPrefix ¶

func CutPrefix(s, prefix string) (after string, found bool)

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.

This is an alias of https://pkg.go.dev/strings#CutPrefix.

func CutSuffix ¶

func CutSuffix(s, suffix string) (before string, found bool)

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.

This is an alias of https://pkg.go.dev/strings#CutSuffix.

func Dedent ¶

func Dedent(s string) string

Dedent attempts to determine the indent-level from the first non-empty line, and trims the indents from all lines.

func EqualFold ¶

func EqualFold(s, t string) 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.

This is an alias of https://pkg.go.dev/strings#EqualFold.

func Fields ¶

func Fields(s string) []string

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.

This is an alias of https://pkg.go.dev/strings#Fields.

func FieldsFunc ¶

func FieldsFunc(s string, f func(rune) bool) []string

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.

This is an alias of https://pkg.go.dev/strings#FieldsFunc.

func FieldsFuncSeq ¶

func FieldsFuncSeq(s string, f func(rune) bool) iter.Seq[string]

FieldsFuncSeq returns an iterator over substrings of s split around runs of Unicode code points satisfying f(c). The iterator yields the same strings that would be returned by FieldsFunc(s), but without constructing the slice.

This is an alias of https://pkg.go.dev/strings#FieldsFuncSeq.

func FieldsSeq ¶

func FieldsSeq(s string) iter.Seq[string]

FieldsSeq returns an iterator over substrings of s split around runs of whitespace characters, as defined by unicode.IsSpace. The iterator yields the same strings that would be returned by Fields(s), but without constructing the slice.

This is an alias of https://pkg.go.dev/strings#FieldsSeq.

func HasPrefix ¶

func HasPrefix(s, prefix string) bool

HasPrefix reports whether the string s begins with prefix.

This is an alias of https://pkg.go.dev/strings#HasPrefix.

func HasSuffix ¶

func HasSuffix(s, suffix string) bool

HasSuffix reports whether the string s ends with suffix.

This is an alias of https://pkg.go.dev/strings#HasSuffix.

func Index ¶

func Index(s, substr string) int

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

This is an alias of https://pkg.go.dev/strings#Index.

func IndexAny ¶

func IndexAny(s, chars string) int

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.

This is an alias of https://pkg.go.dev/strings#IndexAny.

func IndexByte ¶

func IndexByte(s string, c byte) int

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

This is an alias of https://pkg.go.dev/strings#IndexByte.

func IndexFunc ¶

func IndexFunc(s string, f func(rune) bool) int

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

This is an alias of https://pkg.go.dev/strings#IndexFunc.

func IndexRune ¶

func IndexRune(s string, r rune) int

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.

This is an alias of https://pkg.go.dev/strings#IndexRune.

func Join ¶

func Join(elems []string, sep string) string

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.

This is an alias of https://pkg.go.dev/strings#Join.

func LastIndex ¶

func LastIndex(s, substr string) int

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

This is an alias of https://pkg.go.dev/strings#LastIndex.

func LastIndexAny ¶

func LastIndexAny(s, chars string) int

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.

This is an alias of https://pkg.go.dev/strings#LastIndexAny.

func LastIndexByte ¶

func LastIndexByte(s string, c byte) int

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

This is an alias of https://pkg.go.dev/strings#LastIndexByte.

func LastIndexFunc ¶

func LastIndexFunc(s string, f func(rune) bool) int

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

This is an alias of https://pkg.go.dev/strings#LastIndexFunc.

func Lines ¶

func Lines(s string) iter.Seq[string]

Lines returns an iterator over the newline-terminated lines in the string s. The lines yielded by the iterator include their terminating newlines. If s is empty, the iterator yields no lines at all. If s does not end in a newline, the final yielded line will not end in a newline. It returns a single-use iterator.

This is an alias of https://pkg.go.dev/strings#Lines.

func Map ¶

func Map(mapping func(rune) rune, s string) string

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.

This is an alias of https://pkg.go.dev/strings#Map.

func Repeat ¶

func Repeat(s string, count int) string

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.

This is an alias of https://pkg.go.dev/strings#Repeat.

func Replace ¶

func Replace(s, old, new string, n int) string

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.

This is an alias of https://pkg.go.dev/strings#Replace.

func ReplaceAll ¶

func ReplaceAll(s, old, new string) string

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.

This is an alias of https://pkg.go.dev/strings#ReplaceAll.

func Slug ¶

func Slug(s string) string

func Split ¶

func Split(s, sep string) []string

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.

This is an alias of https://pkg.go.dev/strings#Split.

func SplitAfter ¶

func SplitAfter(s, sep string) []string

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.

This is an alias of https://pkg.go.dev/strings#SplitAfter.

func SplitAfterN ¶

func SplitAfterN(s, sep string, n int) []string

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.

This is an alias of https://pkg.go.dev/strings#SplitAfterN.

func SplitAfterSeq ¶

func SplitAfterSeq(s, sep string) iter.Seq[string]

SplitAfterSeq returns an iterator over substrings of s split after each instance of sep. The iterator yields the same strings that would be returned by SplitAfter(s, sep), but without constructing the slice. It returns a single-use iterator.

This is an alias of https://pkg.go.dev/strings#SplitAfterSeq.

func SplitN ¶

func SplitN(s, sep string, n int) []string

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.

This is an alias of https://pkg.go.dev/strings#SplitN.

func SplitSeq ¶

func SplitSeq(s, sep string) iter.Seq[string]

SplitSeq returns an iterator over all substrings of s separated by sep. The iterator yields the same strings that would be returned by Split(s, sep), but without constructing the slice. It returns a single-use iterator.

This is an alias of https://pkg.go.dev/strings#SplitSeq.

func ToCamelCase ¶

func ToCamelCase(s string) string

func ToLower ¶

func ToLower(s string) string

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

This is an alias of https://pkg.go.dev/strings#ToLower.

func ToLowerSpecial ¶

func ToLowerSpecial(c unicode.SpecialCase, s string) string

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

This is an alias of https://pkg.go.dev/strings#ToLowerSpecial.

func ToSnakeCase ¶

func ToSnakeCase(s string) string

func ToString ¶

func ToString[T fmt.Stringer](s T) string

func ToTitle ¶

func ToTitle(s string) string

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

This is an alias of https://pkg.go.dev/strings#ToTitle.

func ToTitleSpecial ¶

func ToTitleSpecial(c unicode.SpecialCase, s string) string

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.

This is an alias of https://pkg.go.dev/strings#ToTitleSpecial.

func ToUpper ¶

func ToUpper(s string) string

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

This is an alias of https://pkg.go.dev/strings#ToUpper.

func ToUpperSpecial ¶

func ToUpperSpecial(c unicode.SpecialCase, s string) string

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

This is an alias of https://pkg.go.dev/strings#ToUpperSpecial.

func ToValidUTF8 ¶

func ToValidUTF8(s, replacement string) string

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.

This is an alias of https://pkg.go.dev/strings#ToValidUTF8.

func Trim ¶

func Trim(s, cutset string) string

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

This is an alias of https://pkg.go.dev/strings#Trim.

func TrimFunc ¶

func TrimFunc(s string, f func(rune) bool) string

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

This is an alias of https://pkg.go.dev/strings#TrimFunc.

func TrimLeft ¶

func TrimLeft(s, cutset string) string

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.

This is an alias of https://pkg.go.dev/strings#TrimLeft.

func TrimLeftFunc ¶

func TrimLeftFunc(s string, f func(rune) bool) string

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

This is an alias of https://pkg.go.dev/strings#TrimLeftFunc.

func TrimPrefix ¶

func TrimPrefix(s, prefix string) string

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

This is an alias of https://pkg.go.dev/strings#TrimPrefix.

func TrimRight ¶

func TrimRight(s, cutset string) string

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.

This is an alias of https://pkg.go.dev/strings#TrimRight.

func TrimRightFunc ¶

func TrimRightFunc(s string, f func(rune) bool) string

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

This is an alias of https://pkg.go.dev/strings#TrimRightFunc.

func TrimSpace ¶

func TrimSpace(s string) string

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

This is an alias of https://pkg.go.dev/strings#TrimSpace.

func TrimSuffix ¶

func TrimSuffix(s, suffix string) string

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

This is an alias of https://pkg.go.dev/strings#TrimSuffix.