Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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.
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](cfg *EncoderConfig) *Encoder[T]
NewEncoder creates a new Encoder.
func (*Encoder[T]) EncodeToken ¶
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 ¶
GenerateFilename generates a file name for the given namespace.
type EncoderConfig ¶ added in v0.8.0
type EncoderConfig struct {
// Namespace is the namespace to back up.
Namespace string
// Do not apply base-64 encoding to BLOBs: Bytes, HLL, RawMap, RawList.
Compact bool
// HasExpressionSIndex indicates whether the backup contains an expression SIndex.
// In that case an asb metaVersion will be bumped.
HasExpressionSIndex bool
}
EncoderConfig contains configuration options for the Encoder.
func NewEncoderConfig ¶ added in v0.8.0
func NewEncoderConfig(namespace string, compact, hasExpressionSIndex bool) *EncoderConfig
NewEncoderConfig returns a new encoder EncoderConfig.
type Validator ¶
type Validator struct {
}
Validator represents backup files validator.
func NewValidator ¶
func NewValidator() *Validator
NewValidator returns new validator instance for files validation.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.