replvar

README

replvar

Variable replacement thingie

Documentation

Index

• func Replace(ctx context.Context, s string, mode string) (string, error)
• func Resolve(ctx context.Context, v string) any
• func ResolveString(ctx context.Context, v string) string
• type Token
  • func (t Token) MathOp() string
• type Var
  • func ParseString(s string, mode string) (Var, error)
  • func ParseVariable(s string) (Var, error)

Functions

func Replace

func Replace(ctx context.Context, s string, mode string) (string, error)

Replace will replace any variable found in s with their value from the context

func Resolve

func Resolve(ctx context.Context, v string) any

Resolve returns the value for a variable name based on the context

Deprecated: use ParseVariable and resolve instead

func ResolveString

func ResolveString(ctx context.Context, v string) string

ResolveString returns the string value for a variable name based on the context

Deprecated: use ParseVariable and resolve instead

Types

type Token

type Token int

const (
	TokenInvalid Token = iota
	TokenVariable
	TokenNumber
	TokenStringConstant
	TokenVariableEnd // }}

	// operators
	TokenDot       // .
	TokenAdd       // +
	TokenSubstract // -
	TokenMultiply  // *
	TokenDivide    // /
	TokenEqual     // ==
	TokenDifferent // !=
	TokenNot       // !
	TokenOr        // |
	TokenLogicOr   // ||
	TokenAnd       // &
	TokenLogicAnd  // &&
	TokenXor       // ^
)

func (Token) MathOp

func (t Token) MathOp() string

type Var

type Var interface {
	Resolve(context.Context) (any, error) // resolve this variable and return its value
	IsStatic() bool                       // if true, it means this var will not change no matter what
}

Var is a resolvable variable

func ParseString

func ParseString(s string, mode string) (Var, error)

ParseString parses a constant string

func ParseVariable

func ParseVariable(s string) (Var, error)

ParseVariable parses a variable string, such as what is typically found inside {{}}