functions

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 8, 2026 License: MIT Imports: 34 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrEmptyList           = errors.New("can't select value from empty list")
	ErrUpperNegativeOrZero = errors.New("upper boundary must be greater than 0")
	ErrLowerGreaterEqual   = errors.New("lower boundary must be less than upper boundary")
	ErrRangeTooLarge       = errors.New("range is too large")
)
View Source
var ErrEmptyPath = errors.New("can't walk empty path")
View Source
var ErrNilArgument = errors.New("nil arguments are not allowed")

Functions

func EnvVarargInit added in v0.7.0

func EnvVarargInit(n *Env, args []any) (any, error)

func FileVarargInit added in v0.7.0

func FileVarargInit(n *File, args []any) (any, error)

func FuncMap

func FuncMap(t *template.Template) template.FuncMap

func Inline

func Inline(t *template.Template) func(value string, data ...any) (string, error)

func ListVarargInit added in v0.7.0

func ListVarargInit(n *List, args []any) (any, error)

func MapVarargInit added in v0.7.0

func MapVarargInit(n *Map, args []any) (any, error)

func Namespace added in v0.7.0

func Namespace[T any](n T) func() any

func Render

func Render(t *template.Template) func(name string, data ...any) (string, error)

func Ternary

func Ternary(truthy, falsy any, cond bool) any

func VarargNamespace added in v0.7.0

func VarargNamespace[T any](n T, fn func(T, []any) (any, error)) func(...any) (any, error)

Types

type Convert added in v0.7.0

type Convert struct{}

func (*Convert) Any added in v0.7.0

func (*Convert) Any(value any) any

func (*Convert) Bool added in v0.7.0

func (*Convert) Bool(value any) bool

func (*Convert) BoolMap added in v0.7.0

func (*Convert) BoolMap(value any) map[string]bool

func (*Convert) Bools added in v0.7.0

func (*Convert) Bools(value any) []bool

func (*Convert) Duration added in v0.7.0

func (*Convert) Duration(value any) time.Duration

func (*Convert) Float added in v0.7.0

func (*Convert) Float(value any) float64

func (*Convert) FloatMap added in v0.7.0

func (*Convert) FloatMap(value any) map[string]float64

func (*Convert) Floats added in v0.7.0

func (*Convert) Floats(value any) []float64

func (*Convert) Int added in v0.7.0

func (*Convert) Int(value any) int64

func (*Convert) IntMap added in v0.7.0

func (*Convert) IntMap(value any) map[string]int64

func (*Convert) Ints added in v0.7.0

func (*Convert) Ints(value any) []int64

func (*Convert) List added in v0.7.0

func (*Convert) List(value any) []any

func (*Convert) Map added in v0.7.0

func (*Convert) Map(value any) map[string]any

func (*Convert) Rune added in v0.7.0

func (*Convert) Rune(value any) rune

func (*Convert) Runes added in v0.7.0

func (*Convert) Runes(value any) []rune

func (*Convert) String added in v0.7.0

func (*Convert) String(value any) string

func (*Convert) StringMap added in v0.7.0

func (*Convert) StringMap(value any) map[string]string

func (*Convert) Strings added in v0.7.0

func (*Convert) Strings(value any) []string

func (*Convert) Time added in v0.7.0

func (*Convert) Time(value any) time.Time

type Data

type Data struct{}

func (*Data) FromBase64

func (*Data) FromBase64(data string) (string, error)

func (*Data) FromDotEnv

func (*Data) FromDotEnv(data string) (any, error)

func (*Data) FromDotEnvExpanded

func (*Data) FromDotEnvExpanded(data string) (any, error)

func (*Data) FromHex

func (*Data) FromHex(data string) (string, error)

func (*Data) FromJSON

func (*Data) FromJSON(data string) (any, error)

func (*Data) FromTOML

func (*Data) FromTOML(data string) (any, error)

func (*Data) FromYAML

func (*Data) FromYAML(data string) (any, error)

func (*Data) Hash

func (*Data) Hash(kind string, value any) (string, error)

func (*Data) ToBase64

func (*Data) ToBase64(value any) string

func (*Data) ToBase64URL

func (*Data) ToBase64URL(value any) string

func (*Data) ToDotEnv

func (*Data) ToDotEnv(value env.Map) (string, error)

func (*Data) ToDotEnvExpanded

func (*Data) ToDotEnvExpanded(value env.Map) (string, error)

func (*Data) ToHex

func (*Data) ToHex(value any) string

func (*Data) ToJSON

func (*Data) ToJSON(value any) (string, error)

func (*Data) ToJSONPretty

func (*Data) ToJSONPretty(value any) (string, error)

func (*Data) ToTOML

func (*Data) ToTOML(value any) (string, error)

func (*Data) ToYAML

func (*Data) ToYAML(value any) (string, error)

func (*Data) Xor

func (*Data) Xor(key string, value any) string

type Env

type Env struct{}

func (*Env) BatchSet added in v0.5.0

func (*Env) BatchSet(m any) error

func (*Env) BatchUnset added in v0.5.0

func (*Env) BatchUnset(keys ...any) error

func (*Env) Escape

func (*Env) Escape(value string) string

func (*Env) Expand

func (*Env) Expand(value string) string

func (*Env) Get

func (*Env) Get(key string) string

func (*Env) IsSet

func (*Env) IsSet(key string) bool

func (*Env) Map

func (*Env) Map() (env.Map, error)

func (*Env) Or

func (*Env) Or(def, key string) string

func (*Env) RawGet

func (*Env) RawGet(key string) string

func (*Env) RawOr

func (*Env) RawOr(def, key string) string

func (*Env) Set

func (*Env) Set(key string, value any) error

func (*Env) ToKey added in v0.5.0

func (*Env) ToKey(key string) string

func (*Env) Unescape

func (*Env) Unescape(value string) string

func (*Env) Unset added in v0.5.0

func (*Env) Unset(key string) error

type File

type File struct{}

func (*File) Content

func (*File) Content(path string) (string, error)

func (*File) Exists

func (*File) Exists(path string) bool

type Filepath

type Filepath struct{}

func (*Filepath) Abs

func (*Filepath) Abs(s string) (string, error)

func (*Filepath) Base

func (*Filepath) Base(s string) string

func (*Filepath) Clean

func (*Filepath) Clean(s string) string

func (*Filepath) Dir

func (*Filepath) Dir(s string) string

func (*Filepath) Exists added in v0.7.0

func (*Filepath) Exists(path string) bool

func (*Filepath) Ext

func (*Filepath) Ext(s string) string

func (*Filepath) FromSlash

func (*Filepath) FromSlash(s string) string

func (*Filepath) Glob

func (*Filepath) Glob(s string) ([]string, error)

func (*Filepath) IsAbs

func (*Filepath) IsAbs(s string) bool

func (*Filepath) IsDir added in v0.7.0

func (*Filepath) IsDir(path string) bool

func (*Filepath) IsFile added in v0.7.0

func (*Filepath) IsFile(path string) bool
func (*Filepath) IsSymlink(path string) bool

func (*Filepath) Join

func (*Filepath) Join(elems ...string) string

func (*Filepath) Match

func (*Filepath) Match(pattern, name string) (bool, error)

func (*Filepath) Rel

func (*Filepath) Rel(target, base string) (string, error)

func (*Filepath) Split

func (*Filepath) Split(s string) []string

func (*Filepath) ToSlash

func (*Filepath) ToSlash(s string) string

func (*Filepath) Volume added in v0.7.0

func (*Filepath) Volume(s string) string

func (*Filepath) Walk

func (*Filepath) Walk(root string, args ...bool) ([]WalkInfo, error)

type List

type List struct{}

func (*List) Concat

func (*List) Concat(values ...any) []any

func (*List) First

func (*List) First(l any) any

func (*List) Join

func (*List) Join(sep string, value any) string

func (*List) Last

func (*List) Last(l any) any

func (*List) New

func (*List) New(values ...any) []any

func (*List) Reverse

func (*List) Reverse(l any) []any

type Map

type Map struct{}

func (*Map) Get

func (*Map) Get(key string, d map[string]any) any

func (*Map) GetOr

func (*Map) GetOr(key string, defaultValue any, d map[string]any) any

func (*Map) IsSet

func (*Map) IsSet(key string, d map[string]any) bool

func (*Map) Keys

func (*Map) Keys(d map[string]any) []any

func (*Map) Merge

func (*Map) Merge(from, to map[string]any) map[string]any

func (*Map) New

func (*Map) New(kv ...any) (map[string]any, error)

func (*Map) Omit

func (*Map) Omit(d map[string]any, keys ...string) map[string]any

func (*Map) Pick

func (*Map) Pick(d map[string]any, keys ...string) map[string]any

func (*Map) Set

func (*Map) Set(key string, value any, d map[string]any) map[string]any

func (*Map) Unset

func (*Map) Unset(key string, d map[string]any) map[string]any

func (*Map) Values

func (*Map) Values(d map[string]any) []any

type Math added in v0.7.0

type Math struct{}

func (*Math) Clamp added in v0.7.0

func (*Math) Clamp(mi, ma, v any) (result any, err error)

func (*Math) Percent added in v0.7.0

func (*Math) Percent(part, total any) float64

type Path

type Path struct{}

func (*Path) Base

func (*Path) Base(s string) string

func (*Path) Clean

func (*Path) Clean(s string) string

func (*Path) Dir

func (*Path) Dir(s string) string

func (*Path) Ext

func (*Path) Ext(s string) string

func (*Path) IsAbs

func (*Path) IsAbs(s string) bool

func (*Path) Join

func (*Path) Join(elems ...string) string

func (*Path) Match

func (*Path) Match(pattern, name string) (bool, error)

func (*Path) Split

func (*Path) Split(s string) []string

type Random added in v0.7.0

type Random struct {
	// contains filtered or unexported fields
}

func NewRandomFuncs added in v0.7.0

func NewRandomFuncs(runeFuncs *Rune) *Random

func (*Random) ASCII added in v0.7.0

func (f *Random) ASCII(length int64) (string, error)

func (*Random) Alpha added in v0.7.0

func (f *Random) Alpha(length int64) (string, error)

func (*Random) AlphaNumeric added in v0.7.0

func (f *Random) AlphaNumeric(length int64) (string, error)

func (*Random) Bool added in v0.7.0

func (f *Random) Bool(args ...float64) (bool, error)

func (*Random) Float added in v0.7.0

func (*Random) Float(args ...float64) (float64, error)

func (*Random) FloatInclusive added in v0.7.0

func (*Random) FloatInclusive(args ...float64) (float64, error)

func (*Random) Graphic added in v0.7.0

func (f *Random) Graphic(length int64) (string, error)

func (*Random) Hex added in v0.7.0

func (f *Random) Hex(length int64) (string, error)

func (*Random) Int added in v0.7.0

func (*Random) Int(args ...int64) (int64, error)

func (*Random) IntInclusive added in v0.7.0

func (*Random) IntInclusive(args ...int64) (int64, error)

func (*Random) Numeric added in v0.7.0

func (f *Random) Numeric(length int64) (string, error)

func (*Random) Pick added in v0.7.0

func (f *Random) Pick(values ...any) (any, error)

func (*Random) PickFrom added in v0.7.0

func (*Random) PickFrom(values []any) (any, error)

func (*Random) String added in v0.7.0

func (f *Random) String(length int64, args ...any) (_ string, err error)

type Regex

type Regex struct {
	// contains filtered or unexported fields
}

func NewRegexFuncs added in v0.7.0

func NewRegexFuncs() *Regex

func (*Regex) Escape

func (*Regex) Escape(str string) string

func (*Regex) Find

func (f *Regex) Find(regex string, str string) (string, error)

func (*Regex) FindAll

func (f *Regex) FindAll(regex string, n int64, str string) ([]string, error)

func (*Regex) Match

func (f *Regex) Match(regex string, str string) (bool, error)

func (*Regex) Replace

func (f *Regex) Replace(regex string, rpl string, str string) (string, error)

func (*Regex) Split

func (f *Regex) Split(regex string, n int64, str string) ([]string, error)

type Rune added in v0.7.0

type Rune struct {
	// contains filtered or unexported fields
}

func NewRuneFuncs added in v0.7.0

func NewRuneFuncs() *Rune

func (*Rune) RangeSet added in v0.7.0

func (f *Rune) RangeSet(lower, upper any) []rune

func (*Rune) RegexSet added in v0.7.0

func (f *Rune) RegexSet(regex string) ([]rune, error)

type String

type String struct{}

func (*String) Bquote

func (*String) Bquote(s string) string

func (*String) Contains

func (*String) Contains(sub, s string) bool

func (*String) EqualFold

func (*String) EqualFold(t, s string) bool

func (*String) HasPrefix

func (*String) HasPrefix(prefix, s string) bool

func (*String) HasSuffix

func (*String) HasSuffix(suffix, s string) bool

func (*String) Indent

func (*String) Indent(level int64, str string) string

func (*String) Join

func (*String) Join(sep string, values ...any) string

func (*String) Lower

func (*String) Lower(s string) string

func (*String) Quote

func (*String) Quote(s string) string

func (*String) Repeat

func (*String) Repeat(count int64, s string) string

func (*String) Replace

func (*String) Replace(old, new, src string) string

func (*String) Split

func (*String) Split(sep string, s string) []string

func (*String) Squote

func (*String) Squote(s string) string

func (*String) Title

func (*String) Title(s string) string

func (*String) Trim

func (*String) Trim(cutset, s string) string

func (*String) TrimLeft

func (*String) TrimLeft(cutset, s string) string

func (*String) TrimPrefix

func (*String) TrimPrefix(prefix, s string) string

func (*String) TrimRight

func (*String) TrimRight(cutset, s string) string

func (*String) TrimSpace

func (*String) TrimSpace(s string) string

func (*String) TrimSuffix

func (*String) TrimSuffix(suffix, s string) string

func (*String) Truncate

func (*String) Truncate(length int64, str string) string

func (*String) Upper

func (*String) Upper(s string) string

type Time

type Time struct{}

func (*Time) Date

func (*Time) Date(t time.Time) string

func (*Time) DateTime

func (*Time) DateTime(t time.Time) string

func (*Time) Format

func (*Time) Format(format string, t time.Time) string

func (*Time) Local

func (*Time) Local(t time.Time) time.Time

func (*Time) Now

func (*Time) Now() time.Time

func (*Time) Offset

func (*Time) Offset(offset string, t time.Time) (time.Time, error)

func (*Time) Round

func (*Time) Round(step string, t time.Time) (time.Time, error)

func (*Time) Since

func (*Time) Since(t time.Time) time.Duration

func (*Time) String

func (*Time) String(t time.Time) string

func (*Time) Time

func (*Time) Time(t time.Time) string

func (*Time) Truncate

func (*Time) Truncate(step string, t time.Time) (time.Time, error)

func (*Time) UTC

func (*Time) UTC(t time.Time) time.Time

func (*Time) Unix

func (*Time) Unix(t time.Time) int64

func (*Time) Until

func (*Time) Until(t time.Time) time.Duration

type WalkInfo

type WalkInfo struct {
	Name     string
	Path     string
	FullPath string
	IsFile   bool
	IsDir    bool
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL