mapstate

package

v0.1.0 Latest Latest Go to latest Published: Jul 29, 2017 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package mapstate implements the State interface for IPFS Cluster by using a map to keep track of the consensus-shared state.

View Source

const Version = 2

Version is the map state Version. States with old versions should perform an upgrade before.

This section is empty.

This section is empty.

type MapState struct {
	PinMap  map[string]api.PinSerial
	Version int
	// contains filtered or unexported fields
}

MapState is a very simple database to store the state of the system using a Go map. It is thread safe. It implements the State interface.

func NewMapState() *MapState

NewMapState initializes the internal map and returns a new MapState object.

func (st *MapState) Add(c api.Pin) error

Add adds a Pin to the internal map.

func (st *MapState) Get(c *cid.Cid) api.Pin

Get returns Pin information for a CID.

func (st *MapState) Has(c *cid.Cid) bool

Has returns true if the Cid belongs to the State.

func (st *MapState) List() []api.Pin

List provides the list of tracked Pins.

func (st *MapState) Restore(r io.Reader) error

Restore takes a reader and restores a snapshot. It should migrate the format if it is not compatible with the current version.

func (st *MapState) Rm(c *cid.Cid) error

Rm removes a Cid from the internal map.

func (st *MapState) Snapshot(w io.Writer) error

Snapshot dumps the MapState to the given writer, in pretty json format.