decoder

Documentation

Index

• Variables
• type Decoder
  • func New(info *distro.OSRelease, runner *interp.Runner) *Decoder
  • func (d *Decoder) DecodeVar(name string, val any) error
  • func (d *Decoder) DecodeVars(val any) error
  • func (d *Decoder) GetFunc(name string) (ScriptFunc, bool)
• type InvalidTypeError
  • func (ite InvalidTypeError) Error() string
• type ScriptFunc
• type VarNotFoundError
  • func (nfe VarNotFoundError) Error() string

Variables

var ErrNotPointerToStruct = errors.New("val must be a pointer to a struct")

Types

type Decoder

type Decoder struct {
	Runner *interp.Runner
	// Enable distro overrides (true by default)
	Overrides bool
	// Enable using like distros for overrides
	LikeDistros bool
	// contains filtered or unexported fields
}

Decoder provides methods for decoding variable values

func New

func New(info *distro.OSRelease, runner *interp.Runner) *Decoder

New creates a new variable decoder

func (*Decoder) DecodeVar

func (d *Decoder) DecodeVar(name string, val any) error

DecodeVar decodes a variable to val using reflection. Structs should use the "sh" struct tag.

func (*Decoder) DecodeVars

func (d *Decoder) DecodeVars(val any) error

DecodeVars decodes all variables to val using reflection. Structs should use the "sh" struct tag.

func (*Decoder) GetFunc

func (d *Decoder) GetFunc(name string) (ScriptFunc, bool)

GetFunc returns a function corresponding to a bash function with the given name

type InvalidTypeError

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

func (InvalidTypeError) Error

func (ite InvalidTypeError) Error() string

type ScriptFunc

type ScriptFunc func(ctx context.Context, opts ...interp.RunnerOption) error

type VarNotFoundError

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

func (VarNotFoundError) Error

func (nfe VarNotFoundError) Error() string