keys

Documentation

Overview

Package keys is a composable framework for constructing badger keys from fields of events.

Index

• func Read(b []byte, elems ...Element)
• func Write(elems ...Element) []byte
• type B
• type E
• type Element
  • func Make(elems ...Element) []Element
• type N
• type S

Functions

func Read

func Read(b []byte, elems ...Element)

Read the contents of a byte slice into the provided list of Element types.

func Write

func Write(elems ...Element) []byte

Write the contents of each Element to a byte slice.

Types

type B

type B = []byte

type E

type E = error

type Element

type Element interface {
	// Write the binary form of the field into the given bytes.Buffer.
	Write(buf *bytes.Buffer)
	// Read accepts a bytes.Buffer and decodes a field from it.
	Read(buf *bytes.Buffer) Element
	// Len gives the length of the bytes output by the type.
	Len() int
}

Element is an enveloper for a type that can Read and Write its binary form.

func Make

func Make(elems ...Element) []Element

Make is a convenience method to wrap a list of Element into a slice.

type N

type N = int

type S

type S = string