atom

Documentation

Index

• Variables
• type Atom
• type Codec
• type FileAtom
  • func NewFileAtom(filename string, codec Codec) *FileAtom
  • func (a *FileAtom) Deref(v any) error
  • func (a *FileAtom) Reset(v any) error
  • func (a *FileAtom) Swap(v any, f func() error) error

Variables

var CodecJSON = &jsonCodec{}

var CodecString = &stringCodec{}

Types

type Atom

type Atom interface {
	// Sets v to the current value in the atom.
	Deref(v any) error
	// Sets the current value in the atom to v.
	Reset(v any) error
	// Runs f in a compare-and-set loop until a write succeeds uncontended.
	// On each iterate of the loop, v is set to the current value in the atom.
	// If no error occurs, the successfully written value remains in v.
	Swap(v any, f func() error) error
}

Atom are uncoordinated, atomic reference cells. Inspired by <https://clojure.org/reference/atoms>.

type Codec

type Codec interface {
	Marshal(v any) ([]byte, error)
	Unmarshal(bs []byte, v any) error
}

type FileAtom

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

A atom durable on the local file system.

func NewFileAtom

func NewFileAtom(filename string, codec Codec) *FileAtom

func (*FileAtom) Deref

func (a *FileAtom) Deref(v any) error

func (*FileAtom) Reset

func (a *FileAtom) Reset(v any) error

func (*FileAtom) Swap

func (a *FileAtom) Swap(v any, f func() error) error