common

Documentation

Index

• type Entry
  • func DecodeEntry(buf []byte) (*Entry, error)
  • func DecodeEntryFromPb(pb protobufs.EntryPb) *Entry
  • func (e *Entry) Encode() []byte
  • func (e *Entry) EncodePb() protobufs.EntryPb
  • func (e *Entry) MatchesAllTags(tags []string) bool
  • func (e *Entry) MatchesAnyTag(tags []string) bool
  • func (e *Entry) MatchesTag(tag string) bool
  • func (e *Entry) String() string
• type NodeID
  • func ParseNodeID(s string) NodeID
  • func (n NodeID) String() string

Types

type Entry

type Entry struct {
	Index     uint64
	Type      int32
	Term      uint64
	Timestamp time.Time
	Tags      []string
	Data      []byte
}

An Entry represents a single record in the storage system. It is used by many packages as the basis of the data model

func DecodeEntry

func DecodeEntry(buf []byte) (*Entry, error)

DecodeEntry turns a protobuf created by EncodeEntry back into an Entry. It will return an error if the specified array is not a valid protobuf for the Entry type.

func DecodeEntryFromPb

func DecodeEntryFromPb(pb protobufs.EntryPb) *Entry

DecodeEntryFromPb parses the special struct from a protobuf entry and turns it into a regular Entry.

func (*Entry) Encode

func (e *Entry) Encode() []byte

Encode encodes an entry in to a byte array using the protobuf defined in this package.

func (*Entry) EncodePb

func (e *Entry) EncodePb() protobufs.EntryPb

EncodePb turns a regular Entry struct into the special struct required in order to generate a protobuf.

func (*Entry) MatchesAllTags

func (e *Entry) MatchesAllTags(tags []string) bool

MatchesAllTags returns true if the specified entry contains all the tags in the "tags" array. It will always return true for an empty "tags" array.

func (*Entry) MatchesAnyTag

func (e *Entry) MatchesAnyTag(tags []string) bool

MatchesAnyTag returns true if the specified entry contains any one of the tags in the "tags" array. It will always return true for an empty "tags" array.

func (*Entry) MatchesTag

func (e *Entry) MatchesTag(tag string) bool

MatchesTag returns true if the specified entry contains the tag from the "tag" argument.

func (*Entry) String

func (e *Entry) String() string

type NodeID

type NodeID uint64

NodeID represents the unique ID of a single Raft node

func ParseNodeID

func ParseNodeID(s string) NodeID

ParseNodeID takes the string generated by "String" and turns it back in to a NodeID.

func (NodeID) String

func (n NodeID) String() string