README
¶
Multistring
Introduction
multistring defines a new type, Wrap, that has the underlying type []string, with methods defined on it that correspond to1 the free functions in the standard library's strings package. Each method performs the equivalent of applying the corresponding function over the slice, like the map higher-order function would.
Example
w := multistring.Wrap{" apple ", "banana ", " celery"}
s := w.TrimSpace().ToUpper().Repeat(3).JoinBy(",")
println(s)
// APPLEAPPLEAPPLE,BANANABANANABANANA,CELERYCELERYCELERY
Method signatures
The methods' signatures are derived from those of the corresponding functions, subject to two transformations:
- The elements in the
Wrapwill be implicitly passed as the first string argument to thestringsfunction - Every return type
Twill be transformed to the slice type[]T, unlessTisstring, in which case it will be transformed toWrap, to allow chaining.
Other methods
There are two additional methods on Wrap that are not derived from strings, JoinBy and MapString:
JoinBycan be used for cases where, as a final step, you want to join a group of strings (contained in aWrap) with the same separator, rather than join a group of strings (passed to theJoinmethod) with a group of separators contained in aWrap.MapStringis the analogue ofstrings.Map, but taking a function that takes astring(func(string) string), instead of arune.
Why did I do this?
For a side project, I needed to apply functions from strings over slices of strings. After writing a few for loops, I decided to abstract it out into what is now Wrap, and then I thought - what if I could generate these method definitions?
A couple of days later...
Documentation
¶
Overview ¶
Package multistring provides wrappers around the standard library's strings package's functions that take string slices.
Index ¶
- type Wrap
- func (w Wrap) Contains(substr string) []bool
- func (w Wrap) ContainsAny(chars string) []bool
- func (w Wrap) ContainsRune(r rune) []bool
- func (w Wrap) Count(substr string) []int
- func (w Wrap) Cut(sep string) (before, after Wrap, found []bool)
- func (w Wrap) EqualFold(t string) []bool
- func (w Wrap) Fields() []Wrap
- func (w Wrap) FieldsFunc(f func(rune) bool) []Wrap
- func (w Wrap) HasPrefix(prefix string) []bool
- func (w Wrap) HasSuffix(suffix string) []bool
- func (w Wrap) Index(substr string) []int
- func (w Wrap) IndexAny(chars string) []int
- func (w Wrap) IndexByte(c byte) []int
- func (w Wrap) IndexFunc(f func(rune) bool) []int
- func (w Wrap) IndexRune(r rune) []int
- func (w Wrap) Join(elems []string) Wrap
- func (w Wrap) JoinBy(sep string) string
- func (w Wrap) LastIndex(substr string) []int
- func (w Wrap) LastIndexAny(chars string) []int
- func (w Wrap) LastIndexByte(c byte) []int
- func (w Wrap) LastIndexFunc(f func(rune) bool) []int
- func (w Wrap) Map(mapping func(rune) rune) Wrap
- func (w Wrap) MapString(mapping func(string) string) Wrap
- func (w Wrap) Repeat(count int) Wrap
- func (w Wrap) Replace(old string, new string, n int) Wrap
- func (w Wrap) ReplaceAll(old string, new string) Wrap
- func (w Wrap) Split(sep string) []Wrap
- func (w Wrap) SplitAfter(sep string) []Wrap
- func (w Wrap) SplitAfterN(sep string, n int) []Wrap
- func (w Wrap) SplitN(sep string, n int) []Wrap
- func (w Wrap) Title() Wrap
- func (w Wrap) ToLower() Wrap
- func (w Wrap) ToLowerSpecial(c unicode.SpecialCase) Wrap
- func (w Wrap) ToTitle() Wrap
- func (w Wrap) ToTitleSpecial(c unicode.SpecialCase) Wrap
- func (w Wrap) ToUpper() Wrap
- func (w Wrap) ToUpperSpecial(c unicode.SpecialCase) Wrap
- func (w Wrap) ToValidUTF8(replacement string) Wrap
- func (w Wrap) Trim(cutset string) Wrap
- func (w Wrap) TrimFunc(f func(rune) bool) Wrap
- func (w Wrap) TrimLeft(cutset string) Wrap
- func (w Wrap) TrimLeftFunc(f func(rune) bool) Wrap
- func (w Wrap) TrimPrefix(prefix string) Wrap
- func (w Wrap) TrimRight(cutset string) Wrap
- func (w Wrap) TrimRightFunc(f func(rune) bool) Wrap
- func (w Wrap) TrimSpace() Wrap
- func (w Wrap) TrimSuffix(suffix string) Wrap
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Wrap ¶
type Wrap []string
func (Wrap) ContainsAny ¶
func (Wrap) ContainsRune ¶
func (Wrap) LastIndexAny ¶
func (Wrap) LastIndexByte ¶
func (Wrap) MapString ¶
MapString applies a function over the strings in the Wrap, returning a new Wrap.
func (Wrap) SplitAfter ¶
func (Wrap) ToLowerSpecial ¶
func (w Wrap) ToLowerSpecial(c unicode.SpecialCase) Wrap
func (Wrap) ToTitleSpecial ¶
func (w Wrap) ToTitleSpecial(c unicode.SpecialCase) Wrap
func (Wrap) ToUpperSpecial ¶
func (w Wrap) ToUpperSpecial(c unicode.SpecialCase) Wrap
Source Files
Directories