fossilizer

Documentation

Overview

Package fossilizer defines types to implement a fossilizer.

Index

• type Adapter
• type Result

Types

type Adapter

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

	// Adds a channel that receives results whenever data is fossilized.
	AddResultChan(resultChan chan *Result)

	// Requests data to be fossilized.
	// Meta is arbitrary data that will be sent to the result channels.
	Fossilize(data []byte, meta []byte) error
}

Adapter must be implemented by a fossilier.

type Result

type Result struct {
	// Evidence created by the fossilizer.
	Evidence interface{}

	// 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.