Struct PutBuilder 

pub struct PutBuilder { /* private fields */ }

A pending put, created with OxiaClient::put. Chain options and .await it.

Implementations

impl PutBuilder

pub fn expected_version_id(self, version_id: i64) -> Self

Makes the put conditional: it succeeds only if the record’s current version id matches (compare-and-swap). Fails with OxiaError::UnexpectedVersionId otherwise.

pub fn expected_record_not_exists(self) -> Self

Makes the put conditional on the record not existing yet. Fails with OxiaError::UnexpectedVersionId if it does.

pub fn partition_key(self, partition_key: impl Into<String>) -> Self

Routes (and co-locates) the record by partition_key instead of by its own key. Records sharing a partition key always live on the same shard.

pub fn sequence_key_deltas(self, deltas: impl IntoIterator<Item = u64>) -> Self

Turns the key into a server-generated sequential key: each delta is added to the current highest sequence and appended as a zero-padded suffix.

Requires partition_key; every delta must be greater than zero; and it cannot be combined with expected_version_id. Awaiting a put that violates any of these fails with OxiaError::InvalidArgument.

pub fn secondary_index( self, index_name: impl Into<String>, secondary_key: impl Into<String>, ) -> Self

Additionally indexes the record under secondary_key in the named secondary index. May be called multiple times.

pub fn ephemeral(self) -> Self

Makes the record ephemeral: it is automatically deleted when this client’s session closes or expires.

Trait Implementations

impl Debug for PutBuilder

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

Formats the value using the given formatter.

impl IntoFuture for PutBuilder

type Output = Result<PutResult, OxiaError>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <PutBuilder as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.