file

Documentation

Index

• type State
  • func New(fn string) (*State, error)
  • func (f *State) Close() error
  • func (f *State) Delete(key string) error
  • func (f *State) Exists(key string) bool
  • func (f *State) Flush() error
  • func (f *State) Get(key string, out interface{}) (bool, error)
  • func (f *State) Set(key string, value interface{}) error
  • func (f *State) SetWithExpires(key string, value interface{}, expiry time.Duration) error

Types

type State

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

State is a simple file backed state store

func New

func New(fn string) (*State, error)

New will create a new state store backed by a file

func (*State) Close

func (f *State) Close() error

Close the state and sync data to the state file

func (*State) Delete

func (f *State) Delete(key string) error

Delete will return data for key in state

func (*State) Exists

func (f *State) Exists(key string) bool

Exists return true if the key exists in state

func (*State) Flush

func (f *State) Flush() error

Flush any pending data to storage

func (*State) Get

func (f *State) Get(key string, out interface{}) (bool, error)

Get will return a value for a given key or nil if not found

func (*State) Set

func (f *State) Set(key string, value interface{}) error

Set a value by key in state. the value must be able to serialize to JSON

func (*State) SetWithExpires

func (f *State) SetWithExpires(key string, value interface{}, expiry time.Duration) error

SetWithExpires will set key and value and it will automatically expire from state after expiry