functions

Documentation

Index

• type ArgType
  • func (typ ArgType) String() string
• type ArgsValidation
• type CIDRContains
  • func (f CIDRContains) Call(args []interface{}) (interface{}, bool)
  • func (f CIDRContains) Desc() FunctionDesc
  • func (f CIDRContains) Name() Fn
• type Concat
  • func (f Concat) Call(args []interface{}) (interface{}, bool)
  • func (f Concat) Desc() FunctionDesc
  • func (f Concat) Name() Fn
• type Entropy
  • func (f Entropy) Call(args []interface{}) (interface{}, bool)
  • func (f Entropy) Desc() FunctionDesc
  • func (f Entropy) Name() Fn
• type Fn
  • func (f Fn) String() string
• type FunctionArgDesc
  • func (arg FunctionArgDesc) ContainsType(typ ArgType) bool
• type FunctionDesc
  • func (f FunctionDesc) RequiredArgs() int
• type IndexOf
  • func (f IndexOf) Call(args []interface{}) (interface{}, bool)
  • func (f IndexOf) Desc() FunctionDesc
  • func (f IndexOf) Name() Fn
• type Length
  • func (f Length) Call(args []interface{}) (interface{}, bool)
  • func (f Length) Desc() FunctionDesc
  • func (f Length) Name() Fn
• type Lower
  • func (f Lower) Call(args []interface{}) (interface{}, bool)
  • func (f Lower) Desc() FunctionDesc
  • func (f Lower) Name() Fn
• type Ltrim
  • func (f Ltrim) Call(args []interface{}) (interface{}, bool)
  • func (f Ltrim) Desc() FunctionDesc
  • func (f Ltrim) Name() Fn
• type MD5
  • func (f MD5) Call(args []interface{}) (interface{}, bool)
  • func (f MD5) Desc() FunctionDesc
  • func (f MD5) Name() Fn
• type Regex
  • func NewRegex() *Regex
  • func (f Regex) Call(args []interface{}) (interface{}, bool)
  • func (f Regex) Desc() FunctionDesc
  • func (f Regex) Name() Fn
• type Replace
  • func (f Replace) Call(args []interface{}) (interface{}, bool)
  • func (f Replace) Desc() FunctionDesc
  • func (f Replace) Name() Fn
• type Rtrim
  • func (f Rtrim) Call(args []interface{}) (interface{}, bool)
  • func (f Rtrim) Desc() FunctionDesc
  • func (f Rtrim) Name() Fn
• type Split
  • func (f Split) Call(args []interface{}) (interface{}, bool)
  • func (f Split) Desc() FunctionDesc
  • func (f Split) Name() Fn
• type Substr
  • func (f Substr) Call(args []interface{}) (interface{}, bool)
  • func (f Substr) Desc() FunctionDesc
  • func (f Substr) Name() Fn
• type Upper
  • func (f Upper) Call(args []interface{}) (interface{}, bool)
  • func (f Upper) Desc() FunctionDesc
  • func (f Upper) Name() Fn

Types

type ArgType

type ArgType uint8

ArgType is the type alias for the argument value type.

const (
	// String represents the string argument type.
	String ArgType = iota
	// Number represents the scalar argument type.
	Number
	// IP represents the IP argument type.
	IP
	// Field represents the argument type that is derived
	// from the field literal. Field literal values can
	// be simple primitive types.
	Field
	// Func represents the argument type that is derived
	// from the function return value.
	Func
	// Slice represents the string slice argument type.
	Slice
	// Unknown is the unknown argument type.
	Unknown
)

func (ArgType) String

func (typ ArgType) String() string

String returns the argument type as a string value.

type ArgsValidation

type ArgsValidation func(args []string) error

ArgsValidation is a function for the custom argument validation logic.

type CIDRContains

type CIDRContains struct{}

CIDRContains determines if the specified IP is contained within the block referenced by the given CIDR mask. The first argument in the slice represents the IP address and the rest of the args represent IP addresses in CIDR notation.

func (CIDRContains) Call

func (f CIDRContains) Call(args []interface{}) (interface{}, bool)

func (CIDRContains) Desc

func (f CIDRContains) Desc() FunctionDesc

func (CIDRContains) Name

func (f CIDRContains) Name() Fn

type Concat

type Concat struct{}

Concat returns a concatenated string of all input arguments.

func (Concat) Call

func (f Concat) Call(args []interface{}) (interface{}, bool)

func (Concat) Desc

func (f Concat) Desc() FunctionDesc

func (Concat) Name

func (f Concat) Name() Fn

type Entropy

type Entropy struct{}

Entropy measures the string entropy

func (Entropy) Call

func (f Entropy) Call(args []interface{}) (interface{}, bool)

func (Entropy) Desc

func (f Entropy) Desc() FunctionDesc

func (Entropy) Name

func (f Entropy) Name() Fn

type Fn

type Fn uint16

Fn is the type alias for function definitions.

const (
	// CIDRContainsFn identifies the CIDR_CONTAINS function
	CIDRContainsFn Fn = iota + 1
	// MD5Fn represents the MD5 function
	MD5Fn
	// ConcatFn represents the CONCAT function
	ConcatFn
	// LtrimFn represents the LTRIM function
	LtrimFn
	// RtrimFn represents the RTRIM function
	RtrimFn
	// LowerFn represents the LOWER function
	LowerFn
	// UpperFn represents the UPPER function
	UpperFn
	// ReplaceFn represents the REPLACE function
	ReplaceFn
	// SplitFn represents the SPLIT function
	SplitFn
	// LengthFn represents the LENGTH function
	LengthFn
	// IndexOfFn represents the INDEXOF function
	IndexOfFn
	// SubstrFn represents the SUBSTR function
	SubstrFn
	// EntropyFn represents the ENTROPY function
	EntropyFn
	// RegexFn represents the REGEX function
	RegexFn
)

func (Fn) String

func (f Fn) String() string

String returns the function name in upper case.

type FunctionArgDesc

type FunctionArgDesc struct {
	Keyword  string
	Required bool
	Types    []ArgType
}

FunctionArgDesc described each function argument.

func (FunctionArgDesc) ContainsType

func (arg FunctionArgDesc) ContainsType(typ ArgType) bool

ContainsType returns true if the argument satisfies the given argument type.

type FunctionDesc

type FunctionDesc struct {
	Name               Fn
	Args               []FunctionArgDesc
	ArgsValidationFunc ArgsValidation
}

FunctionDesc contains the function signature that particular filter function has to satisfy.

func (FunctionDesc) RequiredArgs

func (f FunctionDesc) RequiredArgs() int

RequiredArgs returns the number of the required function args.

type IndexOf

type IndexOf struct{}

IndexOf returns the index of the instance of substring in a given string depending on the provided search order.

func (IndexOf) Call

func (f IndexOf) Call(args []interface{}) (interface{}, bool)

func (IndexOf) Desc

func (f IndexOf) Desc() FunctionDesc

func (IndexOf) Name

func (f IndexOf) Name() Fn

type Length

type Length struct{}

Length returns the number of characters (runes) for string arguments and the size of the slice for slice arguments.

func (Length) Call

func (f Length) Call(args []interface{}) (interface{}, bool)

func (Length) Desc

func (f Length) Desc() FunctionDesc

func (Length) Name

func (f Length) Name() Fn

type Lower

type Lower struct{}

Lower converts the string with all Unicode letters mapped to their lower case.

func (Lower) Call

func (f Lower) Call(args []interface{}) (interface{}, bool)

func (Lower) Desc

func (f Lower) Desc() FunctionDesc

func (Lower) Name

func (f Lower) Name() Fn

type Ltrim

type Ltrim struct{}

Ltrim trims the specified prefix from a string.

func (Ltrim) Call

func (f Ltrim) Call(args []interface{}) (interface{}, bool)

func (Ltrim) Desc

func (f Ltrim) Desc() FunctionDesc

func (Ltrim) Name

func (f Ltrim) Name() Fn

type MD5

type MD5 struct{}

MD5 computes the MD5 hash of the given value.

func (MD5) Call

func (f MD5) Call(args []interface{}) (interface{}, bool)

func (MD5) Desc

func (f MD5) Desc() FunctionDesc

func (MD5) Name

func (f MD5) Name() Fn

type Regex

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

Regex applies single/multiple regular expressions on the provided string arguments.

func NewRegex

func NewRegex() *Regex

NewRegex creates a new regex function.

func (Regex) Call

func (f Regex) Call(args []interface{}) (interface{}, bool)

func (Regex) Desc

func (f Regex) Desc() FunctionDesc

func (Regex) Name

func (f Regex) Name() Fn

type Replace

type Replace struct{}

Replace replaces occurrences in the string as given by arbitrary old/new replacement pairs.

func (Replace) Call

func (f Replace) Call(args []interface{}) (interface{}, bool)

func (Replace) Desc

func (f Replace) Desc() FunctionDesc

func (Replace) Name

func (f Replace) Name() Fn

type Rtrim

type Rtrim struct{}

Rtrim trims the specified suffix from a string.

func (Rtrim) Call

func (f Rtrim) Call(args []interface{}) (interface{}, bool)

func (Rtrim) Desc

func (f Rtrim) Desc() FunctionDesc

func (Rtrim) Name

func (f Rtrim) Name() Fn

type Split

type Split struct{}

Split produces a slice of substrings separated by the given delimiter.

func (Split) Call

func (f Split) Call(args []interface{}) (interface{}, bool)

func (Split) Desc

func (f Split) Desc() FunctionDesc

func (Split) Name

func (f Split) Name() Fn

type Substr

type Substr struct{}

Substr creates a substring of a given string.

func (Substr) Call

func (f Substr) Call(args []interface{}) (interface{}, bool)

func (Substr) Desc

func (f Substr) Desc() FunctionDesc

func (Substr) Name

func (f Substr) Name() Fn

type Upper

type Upper struct{}

Upper converts the string with all Unicode letters mapped to their upper case.

func (Upper) Call

func (f Upper) Call(args []interface{}) (interface{}, bool)

func (Upper) Desc

func (f Upper) Desc() FunctionDesc

func (Upper) Name

func (f Upper) Name() Fn