Struct DecrementOptions 

#[non_exhaustive]
pub struct DecrementOptions {
    pub expiry: Option<Duration>,
    pub initial: Option<u64>,
    pub delta: Option<u64>,
    pub durability_level: Option<DurabilityLevel>,
    pub retry_strategy: Option<Arc<dyn RetryStrategy>>,
}

Options for BinaryCollection::decrement.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

expiry: Option<Duration>

Document expiry time.

initial: Option<u64>

Initial value if the counter document does not exist.

delta: Option<u64>

Amount to decrement by. Defaults to 1.

durability_level: Option<DurabilityLevel>

Durability level for this mutation.

retry_strategy: Option<Arc<dyn RetryStrategy>>

Override the default retry strategy for this operation.

Implementations

impl DecrementOptions

pub fn new() -> Self

Creates a new DecrementOptions with default values.

pub fn expiry(self, expiry: Duration) -> Self

Sets the document expiry time.

pub fn initial(self, initial: u64) -> Self

Sets the initial value if the counter document does not exist.

pub fn delta(self, delta: u64) -> Self

Sets the amount to decrement by.

pub fn durability_level( self, durability_level: impl Into<DurabilityLevel>, ) -> Self

Sets the durability level for this mutation.

pub fn retry_strategy(self, retry_strategy: Arc<dyn RetryStrategy>) -> Self

Sets a custom retry strategy for this operation.

Trait Implementations

impl Clone for DecrementOptions

fn clone(&self) -> DecrementOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecrementOptions

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

Formats the value using the given formatter.

impl Default for DecrementOptions

fn default() -> DecrementOptions

Returns the “default value” for a type.