api

Documentation

Overview

Package api contains the "public" API/artifacts of the serverless log.

Index

• func TileNodeKey(level uint, index uint64) uint
• type Tile
  • func (t Tile) MarshalText() ([]byte, error)
  • func (t *Tile) UnmarshalText(raw []byte) error

Functions

func TileNodeKey

func TileNodeKey(level uint, index uint64) uint

TileNodeKey generates keys used in Tile.Nodes array.

Types

type Tile

type Tile struct {
	// NumLeaves is the number of entries at level 0 of this tile.
	NumLeaves uint

	// Nodes stores the log tree nodes.
	// Nodes are stored linearised using in-order traversal - this isn't completely optimal
	// in terms of storage for partial tiles, but index calculation is relatively
	// straight-forward.
	// Note that only non-ephemeral nodes are stored.
	Nodes [][]byte
}

Tile represents a subtree tile, containing inner nodes of a log tree.

func (Tile) MarshalText

func (t Tile) MarshalText() ([]byte, error)

MarshalText implements encoding/TextMarshaller and writes out a Tile instance in the following format:

<hash size in decimal>\n <num tile leaves in decimal>\n <Nodes[0] base64 encoded>\n ... <Nodes[n] base64 encoded>\n

func (*Tile) UnmarshalText

func (t *Tile) UnmarshalText(raw []byte) error

UnmarshalText implements encoding/TextUnmarshaler and reads tiles which were written by the MarshalText method above.