clientVersion

Documentation

Index

• type Store
  • func LoadStore(kv *versioned.KV) (*Store, error)
  • func NewStore(newVersion version.Version, kv *versioned.KV) (*Store, error)
  • func (s *Store) CheckUpdateRequired(newVersion version.Version) (bool, version.Version, error)
  • func (s *Store) Get() version.Version

Types

type Store

type Store struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Store stores the version of the client's storage.

func LoadStore

func LoadStore(kv *versioned.KV) (*Store, error)

LoadStore loads the clientVersion storage object.

func NewStore

func NewStore(newVersion version.Version, kv *versioned.KV) (*Store, error)

NewStore returns a new clientVersion store.

func (*Store) CheckUpdateRequired

func (s *Store) CheckUpdateRequired(newVersion version.Version) (bool, version.Version, error)

CheckUpdateRequired determines if the storage needs to be upgraded to the new client version. It returns true if an update is required (new > stored) and false otherwise. The old stored version is returned to be used to determine how to upgrade storage. If the new version is older than the stored version, an error is returned.

func (*Store) Get

func (s *Store) Get() version.Version

Get returns the stored version.