vars

package
Version: v0.0.0-...-ed07a65 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2019 License: BSD-3-Clause Imports: 4 Imported by: 0

Documentation

Overview

Package vars contains basic types for manipulating Elvish variables.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsBlackhole

func IsBlackhole(v Var) bool

IsBlackhole returns whether the variable is a blackhole variable.

Types

type Var

type Var interface {
	Set(v interface{}) error
	Get() interface{}
}

Var represents an Elvish variable.

func FromGet

func FromGet(get func() interface{}) Var

FromGet makes a variable from a get callback. The variable is read-only.

func FromPtr

func FromPtr(p interface{}) Var

FromPtr creates a variable from a pointer. The variable is kept in sync with the value the pointer points to, using elvToGo and goToElv conversions when Get and Set.

func FromSetGet

func FromSetGet(set func(interface{}) error, get func() interface{}) Var

FromSetGet makes a variable from a set callback and a get callback.

func NewAnyWithInit

func NewAnyWithInit(v interface{}) Var

NewAnyWithInit creates a variable with an initial value. The variable created can be assigned values of any type.

func NewBlackhole

func NewBlackhole() Var

NewBlackhole returns a blackhole variable. Assignments to a blackhole variable will be discarded, and getting a blackhole variable always returns an empty string.

func NewEnv

func NewEnv(name string) Var

NewEnv returns an environment variable.

func NewRo

func NewRo(v interface{}) Var

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL