version

Documentation

Overview

Package version holds spores version management internal logic.

Index

• Constants
• Variables
• type V
  • func New(data []byte) *V
  • func (*V) Descriptor() ([]byte, []int)
  • func (m *V) GetHash() []byte
  • func (v *V) MarshalBinary() (data []byte, err error)
  • func (v *V) Matches(v2 *V) error
  • func (*V) ProtoMessage()
  • func (m *V) Reset()
  • func (m *V) String() string
  • func (v *V) UnmarshalBinary(data []byte) error

Constants

const VersionBytes = sha512.Size

VersionBytes is the space used by the version when marshalled.

Variables

var ErrVersionMismatch = errors.New("the stored version does not match with required version")

ErrVersionMismatch is returned when two versions are not matching.

var NoVersion = &V{}

NoVersion is the default version that should be returned when no version is available in one store for a specific key.

Types

type V

type V struct {
	Hash []byte `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
}

func New

func New(data []byte) *V

New returns a new version from some data.

func (*V) Descriptor

func (*V) Descriptor() ([]byte, []int)

func (*V) GetHash

func (m *V) GetHash() []byte

func (*V) MarshalBinary

func (v *V) MarshalBinary() (data []byte, err error)

MarshalBinary converts the version to a VersionBytes-sized bytes slice.

func (*V) Matches

func (v *V) Matches(v2 *V) error

Matches returns an error is two versions are not matching.

func (*V) ProtoMessage

func (*V) ProtoMessage()

func (*V) Reset

func (m *V) Reset()

func (*V) String

func (m *V) String() string

func (*V) UnmarshalBinary

func (v *V) UnmarshalBinary(data []byte) error

UnmarshalBinary converts the input to a version.