storage

Documentation

Overview

Package storage defines interfaces for content storage, message storage and codecs.

Index

• Variables
• type Codec
• type ContentReader
• type ContentStorage
• type ContentWriter
• type Decoder
• type Encoder
• type MessageReader
• type MessageStorage
• type MessageWriter
• type ProtoDecodable
• type RawMessage

Variables

var (
	ErrNotFound = errors.New("message was not found")
	ErrTimeout  = errors.New("timeout when accessing message")
	ErrInternal = errors.New("internal error")
)

Types

type Codec

type Codec interface {
	Encoder
	Decoder
}

type ContentReader

type ContentReader interface {
	Read(ctx context.Context, cid cid.Cid) ([]byte, error)
}

ContentReader is responsible for fetching content based on it's CID.

type ContentStorage

type ContentStorage interface {
	ContentReader
	ContentWriter
}

ContentStorage allows its user to access content based on CID.

type ContentWriter

type ContentWriter interface {
	Write(ctx context.Context, content []byte, cid cid.Cid) error
}

ContentWriter writes given content with assigned CID

type Decoder

type Decoder interface {
	Decode(message RawMessage) ProtoDecodable
}

type Encoder

type Encoder interface {
	Encode(message proto.Message) (RawMessage, error)
}

Encoder

type MessageReader

type MessageReader interface {
	Read(ctx context.Context, cid cid.Cid) (ProtoDecodable, error)
}

type MessageStorage

type MessageStorage interface {
	MessageReader
	MessageWriter
}

type MessageWriter

type MessageWriter interface {
	Write(ctx context.Context, message proto.Message) (cid.Cid, error)
}

type ProtoDecodable

type ProtoDecodable interface {
	Decode(message proto.Message) error
}

ProtoDecodable can be used to deserialize message data to proto structure todo: refactor this to just passing generic type when go 1.18 is out

type RawMessage

type RawMessage []byte