multimsg

package

v0.2.1 Latest Latest Go to latest Published: Aug 5, 2021 License: MIT Imports: 12 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cryptoscope/ssb

Links

Open Source Insights

Documentation ¶

Overview ¶

Package multimsg implements a margaret codec to encode multiple kinds of messages to disk. Currently _legacy_ and _gabbygrove_ but should be easily extendable.

Index ¶

type AlterableLog
type MargaretCodec
type MessageType
type MultiMessage
- func NewMultiMessageFromKeyValRaw(msg refs.KeyValueRaw, raw json.RawMessage) MultiMessage
- func NewMultiMessageFromLegacy(msg *legacy.StoredMessage) *MultiMessage
type WrappedLog
- func NewWrappedLog(in AlterableLog) *WrappedLog
- func (wl WrappedLog) Append(val interface{}) (int64, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AlterableLog ¶

type AlterableLog interface {
	margaret.Log
	margaret.Alterer
	io.Closer
}

type MargaretCodec ¶

type MargaretCodec struct{}

func (MargaretCodec) Marshal ¶

func (c MargaretCodec) Marshal(v interface{}) ([]byte, error)

func (MargaretCodec) NewDecoder ¶

func (c MargaretCodec) NewDecoder(r io.Reader) margaret.Decoder

func (MargaretCodec) NewEncoder ¶

func (c MargaretCodec) NewEncoder(w io.Writer) margaret.Encoder

func (MargaretCodec) Unmarshal ¶

func (c MargaretCodec) Unmarshal(data []byte) (interface{}, error)

type MessageType ¶

type MessageType byte

const (
	Unknown MessageType = iota
	Legacy
	Gabby
	MetaFeed
)

type MultiMessage ¶

type MultiMessage struct {
	refs.Message
	// contains filtered or unexported fields
}

MultiMessage attempts to support multiple message formats in the same storage layer currently supports Proto and legacy

func NewMultiMessageFromKeyValRaw ¶ added in v0.2.1

func NewMultiMessageFromKeyValRaw(msg refs.KeyValueRaw, raw json.RawMessage) MultiMessage

func NewMultiMessageFromLegacy ¶

func NewMultiMessageFromLegacy(msg *legacy.StoredMessage) *MultiMessage

func (MultiMessage) AsGabby ¶

func (mm MultiMessage) AsGabby() (*gabbygrove.Transfer, bool)

func (MultiMessage) AsLegacy ¶

func (mm MultiMessage) AsLegacy() (*legacy.StoredMessage, bool)

func (MultiMessage) AsMetaFeed ¶ added in v0.2.1

func (mm MultiMessage) AsMetaFeed() (*metafeed.Message, bool)

func (MultiMessage) MarshalBinary ¶

func (mm MultiMessage) MarshalBinary() ([]byte, error)

func (MultiMessage) Received ¶

func (mm MultiMessage) Received() time.Time

func (*MultiMessage) UnmarshalBinary ¶

func (mm *MultiMessage) UnmarshalBinary(data []byte) error

type WrappedLog ¶

type WrappedLog struct {
	AlterableLog
	// contains filtered or unexported fields
}

func NewWrappedLog ¶

func NewWrappedLog(in AlterableLog) *WrappedLog

func (WrappedLog) Append ¶

func (wl WrappedLog) Append(val interface{}) (int64, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL