hexkey

Documentation

Overview

Package hexkey implements utilities for hexadecimal encoding of blob store keys.

Index

• Variables
• type Config
  • func (c Config) Decode(ekey string) (string, error)
  • func (c Config) Encode(key string) string
  • func (c Config) Start(key string) string
  • func (c Config) WithPrefix(pfx string) Config

Variables

var ErrNotMyKey = errors.New("key does not match config")

ErrNotMyKey is a sentinel error reported by Decode when given a key that does not match the parameters of the config.

Types

type Config

type Config struct {
	// Prefix, if set, is prepended to all keys, separated from the remainder of
	// the key by "/".
	Prefix string

	// Shard, if positive, specifies a prefix length for each hex-encoded key,
	// that will be separated from the key by an intervening "/".
	// For example, if Shard is 2, a key "012345" becomes "01/012345".
	// If Shard ≤ 0, keys are not partitioned.
	Shard int
}

Config carries settings for the encoding and decoding of hex keys. The zero value is ready for use and encodes keys as plain hexadecimal strings.

func (Config) Decode

func (c Config) Decode(ekey string) (string, error)

Decode decodes the specified hex-encoded key according to c. If ekey does not match the expected format, it reports ErrNotMyKey. Otherwise, any error results from decoding the hexadecimal digits.

func (Config) Encode

func (c Config) Encode(key string) string

Encode encodes the specified key as hexadecimal according to c.

func (Config) Start

func (c Config) Start(key string) string

Start returns the hex encoding of a "start" key, a point in the lexiographic sequence of keys.

func (Config) WithPrefix

func (c Config) WithPrefix(pfx string) Config

WithPrefix returns a copy of c with its prefix set to pfx.