Bedrock.Key (bedrock v0.5.2)

Utilities for working with binary keys in Bedrock.

Binary keys in Bedrock are ordered lexicographically, and this module provides utilities for key manipulation, ordering operations, and tuple packing/unpacking.

Tuple Packing

This module provides tuple packing and unpacking functionality that allows complex data structures (tuples, integers, floats, binaries, nil) to be encoded as binary keys that maintain lexicographic ordering.

Summary

Types

t()

Functions

key_after(key)

Returns the next possible key after the given key in lexicographic order.

strinc(key)

Returns the lexicographically next key after the given key by incrementing the last non-0xFF byte.

to_range(key)

Types

t()

@type t() :: binary()

Functions

key_after(key)

@spec key_after(Bedrock.key()) :: binary()

Returns the next possible key after the given key in lexicographic order.

This is useful for creating exclusive upper bounds in range operations. For example, if you want all keys that start with "prefix", you would use the range from "prefix" to key_after("prefix").

Examples

iex> Bedrock.Key.key_after("abc")
"abc\0"

iex> Bedrock.Key.key_after("")
"\0"

strinc(key)

@spec strinc(binary()) :: binary()

Returns the lexicographically next key after the given key by incrementing the last non-0xFF byte.

This is useful for creating tight upper bounds in prefix ranges. Unlike key_after/1 which appends a null byte, strinc/1 creates the minimal lexicographically next key.

Examples

iex> Bedrock.Key.strinc("abc")
"abd"

iex> Bedrock.Key.strinc(<<0, 1, 2>>)
<<0, 1, 3>>
iex> Bedrock.Key.strinc("hello")
"hellp"

Errors

Raises an ArgumentError if the key contains only 0xFF bytes.

iex> Bedrock.Key.strinc(<<0xFF, 0xFF>>)
** (ArgumentError) Key must contain at least one byte not equal to 0xFF

to_range(key)

@spec to_range(Bedrock.key()) :: {Bedrock.key(), Bedrock.key()}