asb

Documentation

Index

• Constants
• type Decoder
  • func NewDecoder[T models.TokenConstraint](src io.Reader, fileName string) (*Decoder[T], error)
  • func (r *Decoder[T]) NextToken() (T, error)
• type Encoder
  • func NewEncoder[T models.TokenConstraint](namespace string, compact bool) *Encoder[T]
  • func (e *Encoder[T]) EncodeToken(token T) ([]byte, error)
  • func (e *Encoder[T]) GenerateFilename(prefix, suffix string) string
  • func (e *Encoder[T]) GetHeader(_ uint64) []byte
• type UserKeyTypesInt
• type Validator
  • func NewValidator() *Validator
  • func (v *Validator) Run(fileName string) error

Constants

const (
	// FormatVersion is the current version of the ASB encoding format
	FormatVersion = "3.1"
)

misc constants

Types

type Decoder

type Decoder[T models.TokenConstraint] struct {
	// contains filtered or unexported fields
}

Decoder contains logic for decoding backup data from the .asb format.

func NewDecoder

func NewDecoder[T models.TokenConstraint](src io.Reader, fileName string) (*Decoder[T], error)

NewDecoder creates a new Decoder.

func (*Decoder[T]) NextToken

func (r *Decoder[T]) NextToken() (T, error)

type Encoder

type Encoder[T models.TokenConstraint] struct {
	// contains filtered or unexported fields
}

Encoder contains logic for encoding backup data into the .asb format. This is a stateful object that must be created for every backup operation.

func NewEncoder

func NewEncoder[T models.TokenConstraint](namespace string, compact bool) *Encoder[T]

NewEncoder creates a new Encoder.

func (*Encoder[T]) EncodeToken

func (e *Encoder[T]) EncodeToken(token T) ([]byte, error)

EncodeToken encodes a token to the ASB format. It returns a byte slice of the encoded token and an error if the encoding fails.

func (*Encoder[T]) GenerateFilename

func (e *Encoder[T]) GenerateFilename(prefix, suffix string) string

GenerateFilename generates a file name for the given namespace.

func (*Encoder[T]) GetHeader

func (e *Encoder[T]) GetHeader(_ uint64) []byte

type UserKeyTypesInt

type UserKeyTypesInt interface {
	int64 | int32 | int16 | int8 | int
}

type Validator

type Validator struct {
}

Validator represents backup files validator.

func NewValidator

func NewValidator() *Validator

NewValidator returns new validator instance for files validation.

func (*Validator) Run

func (v *Validator) Run(fileName string) error

Run performs backup files validation.