Documentation
¶
Overview ¶
Package vartypes contains basic types for manipulating Elvish variables.
Index ¶
- func DelElement(variable Variable, indicies []types.Value) error
- func GetElementErrorLevel(err error) int
- func IsBlackhole(v Variable) bool
- func ShouldBeBool(v types.Value) error
- func ShouldBeList(v types.Value) error
- func ShouldBeMap(v types.Value) error
- func ShouldBeNumber(v types.Value) error
- type Variable
- func GetHeadOfElement(v Variable) Variable
- func MakeElement(v Variable, indicies []types.Value) (Variable, error)
- func NewBlackhole() Variable
- func NewBool(ptr *bool) Variable
- func NewCallback(set func(types.Value) error, get func() types.Value) Variable
- func NewElement(v Variable, a []types.Assocer, i []types.Value) Variable
- func NewEnv(name string) Variable
- func NewNumber(ptr *float64) Variable
- func NewPtr(v types.Value) Variable
- func NewRo(v types.Value) Variable
- func NewRoCallback(get func() types.Value) Variable
- func NewString(ps *string) Variable
- func NewValidatedPtr(v types.Value, vld func(types.Value) error) Variable
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DelElement ¶
DelElement deletes an element. It uses a similar process to MakeElement, except that the last level of container needs to be a Dissocer instead of an Assocer.
func GetElementErrorLevel ¶
GetElementErrorLevel returns the level of an error returned by MakeElement or DelElement. Level 0 represents that the error is about the variable itself. If the argument was not returned from MakeVariable, -1 is returned.
func IsBlackhole ¶
IsBlackhole returns whether the variable is a blackhole variable.
func ShouldBeBool ¶
func ShouldBeList ¶
func ShouldBeMap ¶
func ShouldBeNumber ¶
Types ¶
type Variable ¶
Variable represents an Elvish variable.
func GetHeadOfElement ¶
GetHeadOfElement gets the underlying head variable of an element variable, or nil if the argument is not an element variable.
func MakeElement ¶
MakeElement returns a variable, that when set, simulates the mutation of an element.
func NewBlackhole ¶
func NewBlackhole() Variable
NewBlackhole returns a blackhole variable. Assignments to a blackhole variable will be discarded, and getting a blackhole variable always returns an empty string.
func NewCallback ¶
NewCallback makes a variable from a set callback and a get callback.
func NewElement ¶
NewElement returns an ephemeral variable used for assigning variable element.
func NewRoCallback ¶
NewRoCallback makes a read-only variable from a get callback.
Source Files