go: cuelang.org/go/pkg/strings Index | Files

package strings

import "cuelang.org/go/pkg/strings"

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

Some of the functions in this package are specifically intended as field constraints. For instance, MaxRunes as used in this CUE program

import "strings"

myString: strings.MaxRunes(5)

specifies that the myString should be at most 5 code points.

Index

Package Files

manual.go strings.go

func ByteAt Uses

func ByteAt(b []byte, i int) (byte, error)

ByteAt reports the ith byte of the underlying strings or byte.

func ByteSlice Uses

func ByteSlice(b []byte, start, end int) ([]byte, error)

ByteSlice reports the bytes of the underlying string data from the start index up to but not including the end index.

func Compare Uses

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 Uses

func Contains(s, substr string) bool

Contains reports whether substr is within s.

func ContainsAny Uses

func ContainsAny(s, chars string) bool

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

func Count Uses

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 Fields Uses

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 HasPrefix Uses

func HasPrefix(s, prefix string) bool

HasPrefix tests whether the string s begins with prefix.

func HasSuffix Uses

func HasSuffix(s, suffix string) bool

HasSuffix tests whether the string s ends with suffix.

func Index Uses

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 Uses

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 Join Uses

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

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

func LastIndex Uses

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 Uses

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 MaxRunes Uses

func MaxRunes(s string, max int) bool

MaxRunes reports whether the number of runes (Unicode codepoints) in a string exceeds a certain maximum. MaxRunes can be used a a field constraint to except all strings for which this property holds

func MinRunes Uses

func MinRunes(s string, min int) bool

MinRunes reports whether the number of runes (Unicode codepoints) in a string is at least a certain minimum. MinRunes can be used a a field constraint to except all strings for which this property holds.

func Repeat Uses

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 Uses

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 Runes Uses

func Runes(s string) []rune

Runes returns the Unicode code points of the given string.

func Split Uses

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 Uses

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 Uses

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 Uses

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 ToCamel Uses

func ToCamel(s string) string

ToCamel returns a copy of the string s with all Unicode letters that begin words mapped to lower case.

func ToLower Uses

func ToLower(s string) string

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

func ToTitle Uses

func ToTitle(s string) string

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

func ToUpper Uses

func ToUpper(s string) string

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

func Trim Uses

func Trim(s string, cutset string) string

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

func TrimLeft Uses

func TrimLeft(s string, 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 TrimPrefix Uses

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 Uses

func TrimRight(s string, 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 TrimSpace Uses

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 Uses

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.

Package strings imports 3 packages (graph). Updated 2019-12-07. Refresh now. Tools for package owners.