Struct KeyBuilder 

pub struct KeyBuilder { /* private fields */ }

Builder for segment-safe composite keys.

Segments are escaped and terminated so component boundaries remain unambiguous while preserving byte ordering within each segment.

Example

use prolly::{prefix_range, KeyBuilder};

let prefix = KeyBuilder::new()
    .push_str("conversation")
    .push_str("c42")
    .finish();
let (start, end) = prefix_range(&prefix);

let message_key = KeyBuilder::from_prefix(prefix)
    .push_u64(7)
    .finish();
assert!(message_key >= start);
assert!(end.as_ref().map_or(true, |end| message_key < *end));

Implementations

impl KeyBuilder

pub fn new() -> Self

Create an empty key builder.

pub fn with_capacity(capacity: usize) -> Self

Create an empty key builder with reserved capacity.

pub fn from_prefix(prefix: impl Into<Vec<u8>>) -> Self

Continue building from an existing prefix.

pub fn push_raw(self, bytes: impl AsRef<[u8]>) -> Self

Append raw bytes without segment escaping.

Prefer KeyBuilder::push_segment for tuple-like components.

pub fn push_segment(self, segment: impl AsRef<[u8]>) -> Self

Append one escaped byte segment.

pub fn push_str(self, segment: &str) -> Self

Append one UTF-8 string segment.

pub fn push_u64(self, value: u64) -> Self

Append one lexicographic u64 segment.

pub fn push_u128(self, value: u128) -> Self

Append one lexicographic u128 segment.

pub fn push_i64(self, value: i64) -> Self

Append one lexicographic i64 segment.

pub fn push_i128(self, value: i128) -> Self

Append one lexicographic i128 segment.

pub fn push_timestamp_millis(self, value: u64) -> Self

Append one Unix-millisecond timestamp segment.

pub fn as_slice(&self) -> &[u8]

Borrow the bytes built so far.

pub fn finish(self) -> Vec<u8>

Finish and return the key bytes.

Trait Implementations

impl Clone for KeyBuilder

fn clone(&self) -> KeyBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for KeyBuilder

fn default() -> KeyBuilder

Returns the “default value” for a type.

impl Eq for KeyBuilder

impl PartialEq for KeyBuilder

fn eq(&self, other: &KeyBuilder) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KeyBuilder