Documentation
¶
Overview ¶
Package stringx provides string manipulation functionality specific to protobuf.
Index ¶
- Constants
- func AsciiEqualFold(s, t []byte) bool
- func EnumValueName(s string) string
- func EqualFoldRight(s, t []byte) bool
- func FoldFunc(s []byte) func(s, t []byte) bool
- func GetBuilder() *strings.Builder
- func GoCamelCase(s string) string
- func GoSanitized(s string) string
- func Indices(str, substr string) []int
- func IsAllBlank[S ~string](ss ...S) bool
- func IsAllEmpty[S ~string](ss ...S) bool
- func IsAnyBlank[S ~string](ss ...S) bool
- func IsAnyEmpty[S ~string](ss ...S) bool
- func IsBlank[S ~string](s S) bool
- func IsEmpty[S ~string](s S) bool
- func IsNotBlank[S ~string](s S) bool
- func IsNotEmpty[S ~string](s S) bool
- func IsValidNumber(s string) bool
- func JSONCamelCase(s string) string
- func JSONSnakeCase(s string) string
- func JoinBool[E ~bool](es []E, sep string) string
- func JoinFloat[E constraints.Float](es []E, sep string) string
- func JoinInt[E constraints.Signed](es []E, sep string) string
- func JoinUint[E constraints.Unsigned](es []E, sep string) string
- func MapEntryName(s string) string
- func Match(str string, pattern string) []string
- func Max[S ~string](a, b S) S
- func Min[S ~string](a, b S) S
- func PutBuilder(buf *strings.Builder)
- func Remove(s string, chars string) string
- func ReplaceFunc(str string, f func(rune) string) string
- func SimpleLetterEqualFold(s, t []byte) bool
- func TrimEnumPrefix(s, prefix string) string
- type Builder
- func (b *Builder) Cap() int
- func (b *Builder) Grow(n int)
- func (b *Builder) Len() int
- func (b *Builder) Reset()
- func (b *Builder) String() string
- func (b *Builder) Write(p []byte) (int, error)
- func (b *Builder) WriteBool(bl bool) error
- func (b *Builder) WriteByte(c byte) error
- func (b *Builder) WriteFloat(f float64, fmt byte, prec, bitSize int) error
- func (b *Builder) WriteInt(i int64, base int) error
- func (b *Builder) WriteQuote(s string) error
- func (b *Builder) WriteQuoteRune(r rune) error
- func (b *Builder) WriteQuoteRuneToASCII(r rune) error
- func (b *Builder) WriteQuoteRuneToGraphic(r rune) error
- func (b *Builder) WriteQuoteToASCII(s string) error
- func (b *Builder) WriteQuoteToGraphic(s string) error
- func (b *Builder) WriteRune(r rune) (int, error)
- func (b *Builder) WriteString(s string) (int, error)
- func (b *Builder) WriteUint(i uint64, base int) error
Constants ¶
const ( // DefaultBuilderSize is the default size of the Builder in bytes. DefaultBuilderSize = 1024 // MaxBuilderSize is the maximum size of the Builder in bytes. MaxBuilderSize = 4096 )
Variables ¶
This section is empty.
Functions ¶
func AsciiEqualFold ¶
AsciiEqualFold is a specialization of bytes.EqualFold for use when s is all ASCII (but may contain non-letters) and contains no special-folding letters. See comments on FoldFunc.
func EnumValueName ¶ added in v0.1.1
EnumValueName derives the camel-cased enum value name. See protoc v3.8.0: src/google/protobuf/descriptor.cc:297-313
func EqualFoldRight ¶
EqualFoldRight is a specialization of bytes.EqualFold when s is known to be all ASCII (including punctuation), but contains an 's', 'S', 'k', or 'K', requiring a Unicode fold on the bytes in t. See comments on FoldFunc.
func FoldFunc ¶
FoldFunc returns one of four different case folding equivalence functions, from most general (and slow) to fastest:
1) bytes.EqualFold, if the key s contains any non-ASCII UTF-8 2) EqualFoldRight, if s contains special folding ASCII ('k', 'K', 's', 'S') 3) AsciiEqualFold, no special, but includes non-letters (including _) 4) SimpleLetterEqualFold, no specials, no non-letters.
The letters S and K are special because they map to 3 runes, not just 2:
- S maps to s and to U+017F 'ſ' Latin small letter long s
- k maps to K and to U+212A 'K' Kelvin sign
See https://play.golang.org/p/tTxjOc0OGo
The returned function is specialized for matching against s and should only be given s. It's not curried for performance reasons.
func GetBuilder ¶ added in v0.1.12
GetBuilder retrieves a strings.Builder from the pool.
func GoCamelCase ¶ added in v0.1.1
GoCamelCase camel-cases a protobuf name for use as a Go identifier.
If there is an interior underscore followed by a lower case letter, drop the underscore and convert the letter to upper case.
func GoSanitized ¶ added in v0.1.1
GoSanitized converts a string to a valid Go identifier.
func IsAllBlank ¶
IsAllBlank Checks if all of the CharSequences are empty ("") or whitespace only.
func IsAllEmpty ¶
IsAllEmpty Checks if all of the strings are empty ("")
func IsAnyBlank ¶
IsAnyBlank Checks if any of the string are empty ("") or whitespace only.
func IsAnyEmpty ¶
IsAnyEmpty Checks if any of the strings are empty ("")
func IsNotBlank ¶
IsNotBlank Checks if a string is not empty ("") and not whitespace only.
func IsNotEmpty ¶
IsNotEmpty Checks if a string is not empty ("")
func IsValidNumber ¶
IsValidNumber reports whether s is a valid number.
func JSONCamelCase ¶ added in v0.1.1
JSONCamelCase converts a snake_case identifier to a camelCase identifier, according to the protobuf JSON specification.
func JSONSnakeCase ¶ added in v0.1.1
JSONSnakeCase converts a camelCase identifier to a snake_case identifier, according to the protobuf JSON specification.
func MapEntryName ¶ added in v0.1.1
MapEntryName derives the name of the map entry message given the field name. See protoc v3.8.0: src/google/protobuf/descriptor.cc:254-276,6057
func PutBuilder ¶ added in v0.1.12
PutBuilder returns a strings.Builder to the pool.
func SimpleLetterEqualFold ¶
SimpleLetterEqualFold is a specialization of bytes.EqualFold for use when s is all ASCII letters (no underscores, etc) and also doesn't contain 'k', 'K', 's', or 'S'. See comments on FoldFunc.
func TrimEnumPrefix ¶ added in v0.1.1
TrimEnumPrefix trims the enum name prefix from an enum value name, where the prefix is all lowercase without underscores. See protoc v3.8.0: src/google/protobuf/descriptor.cc:330-375
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
func NewBuilder ¶
func NewBuilder() *Builder
func NewBuilderBuilder ¶
func (*Builder) Cap ¶
Cap returns the capacity of the builder's underlying byte slice. It is the total space allocated for the string being built and includes any bytes already written.
func (*Builder) Grow ¶
Grow grows b's capacity, if necessary, to guarantee space for another n bytes. After Grow(n), at least n bytes can be written to b without another allocation. If n is negative, Grow panics.
func (*Builder) Write ¶
Write appends the contents of p to b's buffer. Write always returns len(p), nil.
func (*Builder) WriteByte ¶
WriteByte appends the byte c to b's buffer. The returned error is always nil.
func (*Builder) WriteFloat ¶
WriteFloat appends the string form of the floating-point number f.
func (*Builder) WriteQuote ¶
WriteQuote appends a double-quoted Go string literal representing s.
func (*Builder) WriteQuoteRune ¶
WriteQuoteRune appends a single-quoted Go character literal representing the rune.
func (*Builder) WriteQuoteRuneToASCII ¶
WriteQuoteRuneToASCII appends a single-quoted Go character literal representing the rune.
func (*Builder) WriteQuoteRuneToGraphic ¶
WriteQuoteRuneToGraphic appends a single-quoted Go character literal representing the rune.
func (*Builder) WriteQuoteToASCII ¶
WriteQuoteToASCII appends a double-quoted Go string literal representing s.
func (*Builder) WriteQuoteToGraphic ¶
WriteQuoteToGraphic appends a double-quoted Go string literal representing s.
func (*Builder) WriteRune ¶
WriteRune appends the UTF-8 encoding of Unicode code point r to b's buffer. It returns the length of r and a nil error.
func (*Builder) WriteString ¶
WriteString appends the contents of s to b's buffer. It returns the length of s and a nil error.
Source Files
Directories