env

Documentation

Index

• Variables
• func BatchSet(m Map) error
• func BatchUnset(keys []string) error
• func Escape(value string) string
• func Expand(value string) string
• func Get(key string) string
• func IsSet(key string) bool
• func Lookup(key string) (string, bool)
• func Marshal(value Map, options ...EncoderOption) ([]byte, error)
• func Or(key, defaultValue string) string
• func RawExpand(value string, lookup LookupFunc) string
• func RawGet(key string) string
• func RawLookup(key string) (string, bool)
• func RawOr(key, defaultValue string) string
• func Set(key, value string) error
• func ToKey(key string) string
• func Unescape(value string) string
• func Unmarshal(data []byte, v any, options ...DecoderOption) error
• func Unset(key string) error
• type Decoder
  • func NewDecoder(r io.Reader, options ...DecoderOption) *Decoder
  • func (d *Decoder) Decode(v any) error
• type DecoderOption
  • func WithDecoderExpand(val bool) DecoderOption
  • func WithDecoderLookup(lookup LookupFunc) DecoderOption
• type Encoder
  • func NewEncoder(w io.Writer, options ...EncoderOption) *Encoder
  • func (e *Encoder) Encode(v any) error
• type EncoderOption
  • func WithEncoderExpand(val bool) EncoderOption
  • func WithEncoderLookup(lookup LookupFunc) EncoderOption
• type ExpandFunc
• type LookupFunc
• type Map
  • func Environ() (Map, error)

Variables

var (
	ErrNotKV           = errors.New("not an env key-value")
	ErrInvalidKVFormat = errors.New("invalid env key-value format")
	ErrUnmatchedQuote  = errors.New("unmatched quote in value")
)

Functions

func BatchSet

func BatchSet(m Map) error

func BatchUnset

func BatchUnset(keys []string) error

func Escape

func Escape(value string) string

func Expand

func Expand(value string) string

func Get

func Get(key string) string

func IsSet

func IsSet(key string) bool

func Lookup

func Lookup(key string) (string, bool)

func Marshal

func Marshal(value Map, options ...EncoderOption) ([]byte, error)

func Or

func Or(key, defaultValue string) string

func RawExpand

func RawExpand(value string, lookup LookupFunc) string

func RawGet

func RawGet(key string) string

func RawLookup

func RawLookup(key string) (string, bool)

func RawOr

func RawOr(key, defaultValue string) string

func Set

func Set(key, value string) error

func ToKey

func ToKey(key string) string

func Unescape

func Unescape(value string) string

func Unmarshal

func Unmarshal(data []byte, v any, options ...DecoderOption) error

func Unset

func Unset(key string) error

Types

type Decoder

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

func NewDecoder

func NewDecoder(r io.Reader, options ...DecoderOption) *Decoder

func (*Decoder) Decode

func (d *Decoder) Decode(v any) error

type DecoderOption

type DecoderOption = func(d *Decoder)

func WithDecoderExpand

func WithDecoderExpand(val bool) DecoderOption

func WithDecoderLookup

func WithDecoderLookup(lookup LookupFunc) DecoderOption

type Encoder

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

func NewEncoder

func NewEncoder(w io.Writer, options ...EncoderOption) *Encoder

func (*Encoder) Encode

func (e *Encoder) Encode(v any) error

type EncoderOption

type EncoderOption = func(d *Encoder)

func WithEncoderExpand

func WithEncoderExpand(val bool) EncoderOption

func WithEncoderLookup

func WithEncoderLookup(lookup LookupFunc) EncoderOption

type ExpandFunc

type ExpandFunc = func(value string) string

type LookupFunc

type LookupFunc = func(value string) (string, bool)

type Map

type Map = map[string]string

func Environ

func Environ() (Map, error)