storage

Documentation

Overview

Package storage is responsible for the persistent storage of state.

Sous state is stored in a file hierarchy like this:

/
    defs.yaml
    manifests/
        github.com/
            username/
                reponame/
                    dirname/
                        subdirname.yaml

Index

• type DiskStateManager
  • func NewDiskStateManager(baseDir string) *DiskStateManager
  • func (dsm *DiskStateManager) ReadState() (*sous.State, error)
  • func (dsm *DiskStateManager) WriteState(s *sous.State) error

Types

type DiskStateManager

type DiskStateManager struct {
	Codec *hy.Codec
	// contains filtered or unexported fields
}

DiskStateManager implements StateReader and StateWriter using disk storage as its back-end.

func NewDiskStateManager

func NewDiskStateManager(baseDir string) *DiskStateManager

NewDiskStateManager returns a new DiskStateManager configured to read and write from a filesystem tree containing YAML files.

func (*DiskStateManager) ReadState

func (dsm *DiskStateManager) ReadState() (*sous.State, error)

ReadState loads the entire intended state of the world from a dir.

func (*DiskStateManager) WriteState

func (dsm *DiskStateManager) WriteState(s *sous.State) error

WriteState records the entire intended state of the world to a dir.