Struct PartitionKeyBuilder 

pub struct PartitionKeyBuilder(/* private fields */);

Builder for a v1 canonical logical partition key.

Implementations

impl PartitionKeyBuilder

pub fn new(aggregate_type: AggregateTypeId) -> Self

Starts a partition key with its purpose namespace, version, and aggregate type.

pub fn push_bool(&mut self, value: bool) -> Result<&mut Self, KeyEncodingError>

Appends a canonical Boolean component.

pub fn push_u32(&mut self, value: u32) -> Result<&mut Self, KeyEncodingError>

Appends an unsigned 32-bit ordered component.

pub fn push_u64(&mut self, value: u64) -> Result<&mut Self, KeyEncodingError>

Appends an unsigned 64-bit ordered component.

pub fn push_i32(&mut self, value: i32) -> Result<&mut Self, KeyEncodingError>

Appends a signed 32-bit component whose bytes preserve numeric order.

pub fn push_i64(&mut self, value: i64) -> Result<&mut Self, KeyEncodingError>

Appends a signed 64-bit component whose bytes preserve numeric order.

pub fn push_timestamp( &mut self, value: Timestamp, ) -> Result<&mut Self, KeyEncodingError>

Appends a canonical timestamp component.

pub fn push_date(&mut self, value: Date) -> Result<&mut Self, KeyEncodingError>

Appends a canonical date component.

pub fn push_enum_variant( &mut self, value: EnumVariantId, ) -> Result<&mut Self, KeyEncodingError>

Appends a canonical declared-enum variant component.

pub fn push_uuid( &mut self, value: &[u8; 16], ) -> Result<&mut Self, KeyEncodingError>

Appends fixed-width UUID network-order bytes.

pub fn push_bytes( &mut self, value: &[u8], ) -> Result<&mut Self, KeyEncodingError>

Appends a length-prefixed exact byte component.

pub fn push_str(&mut self, value: &str) -> Result<&mut Self, KeyEncodingError>

Appends a length-prefixed exact UTF-8 component without normalization.

pub fn push_ordered_bytes( &mut self, value: &[u8], ) -> Result<&mut Self, KeyEncodingError>

Appends zero-escaped bytes whose encoded order preserves byte order.

pub fn push_ordered_bytes_prefix( &mut self, value: &[u8], ) -> Result<&mut Self, KeyEncodingError>

Appends the non-terminated prefix of one ordered-byte component.

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

Returns the currently encoded prefix and components.

pub fn finish(self) -> Result<PartitionKey, KeyEncodingError>

Finishes the bounded canonical logical partition key.

Trait Implementations

impl Clone for PartitionKeyBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartitionKeyBuilder

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

Formats the value using the given formatter.