fossilizer

Documentation

Overview

Package fossilizer defines types to implement a fossilizer.

Index

• type Adapter
• type Event
• type EventType
• type Result

Types

type Adapter

type Adapter interface {
	// Returns arbitrary information about the adapter.
	GetInfo(context.Context) (interface{}, error)

	// Adds a channel that receives events from the fossilizer
	AddFossilizerEventChan(chan *Event)

	// Requests data to be fossilized.
	// Meta is arbitrary data that will be forwarded to the websocket.
	Fossilize(ctx context.Context, data []byte, meta []byte) error
}

Adapter must be implemented by a fossilier.

type Event

type Event struct {
	EventType EventType
	Data      interface{}
}

Event is the object fossilizers send to notify of important events.

type EventType

type EventType string

EventType lets you know the kind of event received. A client should ignore events it doesn't care about or doesn't understand.

const (
	// DidFossilizeLink means that the link was fossilized
	DidFossilizeLink EventType = "DidFossilizeLink"
)

type Result

type Result struct {
	// Evidence created by the fossilizer.
	Evidence cs.Evidence

	// The data that was fossilized.
	Data []byte

	// The meta data that was given to Adapter.Fossilize.
	Meta []byte
}

Result is the type sent to the result channels.