storage

Documentation

Overview

Package storage provides Cogs with access to storage mechanisms that hold data that a Cog may need for operations.

Index

• type Reader

Types

type Reader

type Reader interface {
	// Read will allow retrieval of a value at key 'k' and store it in 'v'.
	// 'v' must be a pointer to a supportted type.
	// This can be an int, uint, float64, string or []byte.
	// A key cannot be larger than 1MiB.
	Read(cog, k string, v interface{}) error
}

KeyValue allows a Cog to interact with Marmot's global key value store. This is for storing information needed by a Cog to operate, such as certs or passwords. It should not store large data or data passed between Cogs in a Labor.