package strings

Import Path
	strings (on golang.org and go.dev)

Dependency Relation
	imports 7 packages, and imported by 73 packages

Involved Source Files
	    builder.go
	    compare.go
	    reader.go
	    replace.go
	    search.go
	d-> strings.go

Exported Type Names

type Builder (struct) A Builder is used to efficiently build a string using Write methods. It minimizes memory copying. The zero value is ready to use. Do not copy a non-zero Builder. (*T) Cap() int (*T) Grow(n int) (*T) Len() int (*T) Reset() (*T) String() string (*T) Write(p []byte) (int, error) (*T) WriteByte(c byte) error (*T) WriteRune(r rune) (int, error) (*T) WriteString(s string) (int, error) *T : expvar.Var *T : fmt.Stringer *T : io.ByteWriter *T : io.StringWriter *T : io.Writer
type Reader (struct) A Reader implements the io.Reader, io.ReaderAt, io.Seeker, io.WriterTo, io.ByteScanner, and io.RuneScanner interfaces by reading from a string. The zero value for Reader operates like a Reader of an empty string. (*T) Len() int (*T) Read(b []byte) (n int, err error) (*T) ReadAt(b []byte, off int64) (n int, err error) (*T) ReadByte() (byte, error) (*T) ReadRune() (ch rune, size int, err error) (*T) Reset(s string) (*T) Seek(offset int64, whence int) (int64, error) (*T) Size() int64 (*T) UnreadByte() error (*T) UnreadRune() error (*T) WriteTo(w io.Writer) (n int64, err error) *T : compress/flate.Reader *T : image/jpeg.Reader *T : io.ByteReader *T : io.ByteScanner *T : io.Reader *T : io.ReaderAt *T : io.ReadSeeker *T : io.RuneReader *T : io.RuneScanner *T : io.Seeker *T : io.WriterTo func NewReader(s string) *Reader
type Replacer (struct) Replacer replaces a list of strings with replacements. It is safe for concurrent use by multiple goroutines. (*T) Replace(s string) string (*T) WriteString(w io.Writer, s string) (n int, err error) func NewReplacer(oldnew ...string) *Replacer
Exported Values
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. 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.
func Contains(s, substr string) bool Contains reports whether substr is within s.
func ContainsAny(s, chars string) bool ContainsAny reports whether any Unicode code points in chars are within s.
func ContainsRune(s string, r rune) bool ContainsRune reports whether the Unicode code point r is within s.
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.
func EqualFold(s, t string) bool EqualFold reports whether s and t, interpreted as UTF-8 strings, are equal under Unicode case-folding, which is a more general form of case-insensitivity.
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.
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.
func HasPrefix(s, prefix string) bool HasPrefix tests whether the string s begins with prefix.
func HasSuffix(s, suffix string) bool HasSuffix tests whether the string s ends with suffix.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
func NewReader(s string) *Reader NewReader returns a new Reader reading from s. It is similar to bytes.NewBufferString but more efficient and read-only.
func NewReplacer(oldnew ...string) *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.
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.
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.
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.
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.
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.
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.
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.
func Title(s string) string Title returns a copy of the string s with all Unicode letters that begin words mapped to their Unicode title case. BUG(rsc): The rule Title uses for word boundaries does not handle Unicode punctuation properly.
func ToLower(s string) string ToLower returns s with all Unicode letters mapped to their lower case.
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.
func ToTitle(s string) string ToTitle returns a copy of the string s with all Unicode letters mapped to their Unicode title case.
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.
func ToUpper(s string) string ToUpper returns s with all Unicode letters mapped to their upper case.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.