streamstore

Documentation

Overview

streamstore implements helpers to store large data streams in a repository

Index

• Constants
• func NewStreamer(kw *kopia.Wrapper, tenant string, service path.ServiceType) *storeStreamer
• type Collectable
  • func DetailsCollector(mr Marshaller) Collectable
  • func DetailsReader(unmr Unmarshaller) Collectable
  • func FaultErrorsCollector(mr Marshaller) Collectable
  • func FaultErrorsReader(unmr Unmarshaller) Collectable
• type Collector
• type CollectorWriter
• type Marshaller
• type Reader
• type Streamer
• type Unmarshaller
• type Writer

Constants

const (
	FaultErrorsType = "fault_error"

	DetailsType = "details"
)

Functions

func NewStreamer

func NewStreamer(
	kw *kopia.Wrapper,
	tenant string,
	service path.ServiceType,
) *storeStreamer

NewStreamer creates a new streamstore Streamer for stream writing metadata files to the store.

Types

type Collectable

type Collectable struct {
	Unmr Unmarshaller

	Type string
	// contains filtered or unexported fields
}

func DetailsCollector

func DetailsCollector(mr Marshaller) Collectable

DetailsCollector generates a collection of details.DetailsModel entries containing the marshalled bytes from the provided marshaller.

func DetailsReader

func DetailsReader(unmr Unmarshaller) Collectable

DetailsReader reads a collection of details.DetailsModel entries using the provided unmarshaller.

func FaultErrorsCollector

func FaultErrorsCollector(mr Marshaller) Collectable

FaultErrorsCollector generates a collection of fault.Errors containing the marshalled bytes from the provided marshaller.

func FaultErrorsReader

func FaultErrorsReader(unmr Unmarshaller) Collectable

FaultErrorsReader reads a collection of fault.Errors entries using the provided unmarshaller.

type Collector

type Collector interface {
	Collect(context.Context, Collectable) error
}

type CollectorWriter

type CollectorWriter interface {
	Collector
	Writer
}

type Marshaller

type Marshaller interface {
	Marshal() ([]byte, error)
}

Marshallers are used to convert structs into bytes to be persisted in the store.

type Reader

type Reader interface {
	Read(context.Context, string, Collectable, *fault.Bus) error
}

type Streamer

type Streamer interface {
	Collector
	Writer
	Reader
}

Streamer is the core interface for all types of data streamed to and from the store.

type Unmarshaller

type Unmarshaller func(io.ReadCloser) error

Unmarshallers are used to serialize the bytes in the store into the original struct.

type Writer

type Writer interface {
	Write(context.Context, []identity.Reasoner, *fault.Bus) (string, error)
}