Struct CreateTransactionOptions

#[non_exhaustive]
pub struct CreateTransactionOptions<'hint> {
    pub hint: Option<&'hint str>,
    pub is_read_only: bool,
}

Options for customizing a transaction. Used with Store::transaction_with_options.

let mut options = CreateTransactionOptions::new();
options.hint = Some("my transaction name");
options.is_read_only = true;

ditto
    .store()
    .transaction_with_options(options, async |txn| {
        // do transaction stuff
        Ok::<_, DittoError>(TransactionCompletionAction::Commit)
    })
    .await
    .unwrap();

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.

hint: Option<&'hint str>

A hint used for debugging and logging

is_read_only: bool

Whether the transaction should be created read-only

Implementations

impl CreateTransactionOptions<'_>

pub fn new() -> Self

Create a new, default CreateTransactionOptions.

Trait Implementations

impl<'hint> Clone for CreateTransactionOptions<'hint>

fn clone(&self) -> CreateTransactionOptions<'hint>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'hint> Debug for CreateTransactionOptions<'hint>

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

Formats the value using the given formatter.

impl Default for CreateTransactionOptions<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'hint> PartialEq for CreateTransactionOptions<'hint>

fn eq(&self, other: &CreateTransactionOptions<'hint>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'hint> StructuralPartialEq for CreateTransactionOptions<'hint>