archive

Documentation

Overview

Package archive offers support for the compact storage and retrieval of state in memory.

Index

• type BooleanArchive
  • func New(size int) *BooleanArchive
  • func (a *BooleanArchive) ArchiveLen() int
  • func (a *BooleanArchive) Decode(encoding string) error
  • func (a *BooleanArchive) Encoding() string
  • func (a *BooleanArchive) IsEquivalentTo(b *BooleanArchive) bool
  • func (a *BooleanArchive) Len() int
  • func (a *BooleanArchive) SetValue(entryIndex int, value bool)
  • func (a *BooleanArchive) Value(entryIndex int) bool

Types

type BooleanArchive

type BooleanArchive struct {
	// contains filtered or unexported fields
}

BooleanArchive offers a compact storage and retrieval mechanism for a fixed size set of boolean data.

func New

func New(size int) *BooleanArchive

BooleanArchive offers a compact storage and retrieval mechanism for a fixed size set of boolean data.

func (*BooleanArchive) ArchiveLen

func (a *BooleanArchive) ArchiveLen() int

ArchiveLen returns the number of uint64 integers used to store archived boolean data.

func (*BooleanArchive) Decode

func (a *BooleanArchive) Decode(encoding string) error

func (*BooleanArchive) Encoding

func (a *BooleanArchive) Encoding() string

func (*BooleanArchive) IsEquivalentTo

func (a *BooleanArchive) IsEquivalentTo(b *BooleanArchive) bool

func (*BooleanArchive) Len

func (a *BooleanArchive) Len() int

Len returns the length of entries stored in the archive.

func (*BooleanArchive) SetValue

func (a *BooleanArchive) SetValue(entryIndex int, value bool)

SetValue stores the supplied boolean value in the archive at entryIndex.

func (*BooleanArchive) Value

func (a *BooleanArchive) Value(entryIndex int) bool

Value retrieves the boolean value stored at the requested entryIndex of the archive.