stringx

Documentation

Index

• Variables
• func Contains(list []string, str string) bool
• func Filter(s string, filter func(r rune) bool) string
• func FirstN(s string, n int, ellipsis ...string) string
• func HasEmpty(args ...string) bool
• func Join(sep byte, elem ...string) string
• func NotEmpty(args ...string) bool
• func Rand() string
• func RandId() string
• func Randn(n int) string
• func Remove(strings []string, strs ...string) []string
• func Reverse(s string) string
• func Seed(seed int64)
• func Substr(str string, start, stop int) (string, error)
• func TakeOne(valid, or string) string
• func TakeWithPriority(fns ...func() string) string
• func ToCamelCase(s string) string
• func Union(first, second []string) []string
• type Replacer
  • func NewReplacer(mapping map[string]string) Replacer
• type Trie
  • func NewTrie(words []string, opts ...TrieOption) Trie
• type TrieOption
  • func WithMask(mask rune) TrieOption

Variables

var (
	// ErrInvalidStartPosition is an error that indicates the start position is invalid.
	ErrInvalidStartPosition = errors.New("start position is invalid")
	// ErrInvalidStopPosition is an error that indicates the stop position is invalid.
	ErrInvalidStopPosition = errors.New("stop position is invalid")
)

Functions

func Contains

func Contains(list []string, str string) bool

Contains checks if str is in list.

func Filter

func Filter(s string, filter func(r rune) bool) string

Filter filters chars from s with given filter function.

func FirstN

func FirstN(s string, n int, ellipsis ...string) string

FirstN returns first n runes from s.

func HasEmpty

func HasEmpty(args ...string) bool

HasEmpty checks if there are empty strings in args.

func Join

func Join(sep byte, elem ...string) string

Join joins any number of elements into a single string, separating them with given sep. Empty elements are ignored. However, if the argument list is empty or all its elements are empty, Join returns an empty string.

func NotEmpty

func NotEmpty(args ...string) bool

NotEmpty checks if all strings are not empty in args.

func Rand

func Rand() string

Rand returns a random string.

func RandId

func RandId() string

RandId returns a random id string.

func Randn

func Randn(n int) string

Randn returns a random string with length n.

func Remove

func Remove(strings []string, strs ...string) []string

Remove removes given strs from strings.

func Reverse

func Reverse(s string) string

Reverse reverses s.

func Seed

func Seed(seed int64)

Seed sets the seed to seed.

func Substr

func Substr(str string, start, stop int) (string, error)

Substr returns runes between start and stop [start, stop) regardless of the chars are ascii or utf8.

func TakeOne

func TakeOne(valid, or string) string

TakeOne returns valid string if not empty or later one.

func TakeWithPriority

func TakeWithPriority(fns ...func() string) string

TakeWithPriority returns the first not empty result from fns.

func ToCamelCase

func ToCamelCase(s string) string

ToCamelCase returns the string that converts the first letter to lowercase.

func Union

func Union(first, second []string) []string

Union merges the strings in first and second.

Types

type Replacer

type Replacer interface {
	Replace(text string) string
}

Replacer interface wraps the Replace method.

func NewReplacer

func NewReplacer(mapping map[string]string) Replacer

NewReplacer returns a Replacer.

type Trie

type Trie interface {
	Filter(text string) (string, []string, bool)
	FindKeywords(text string) []string
}

A Trie is a tree implementation that used to find elements rapidly.

func NewTrie

func NewTrie(words []string, opts ...TrieOption) Trie

NewTrie returns a Trie.

type TrieOption

type TrieOption func(trie *trieNode)

TrieOption defines the method to customize a Trie.

func WithMask

func WithMask(mask rune) TrieOption

WithMask customizes a Trie with keywords masked as given mask char.