Struct Transaction 

pub struct Transaction {
    pub transaction_id: String,
    /* private fields */
}

Represents a Firestore Transaction.

Transactions provide a way to ensure that a set of reads and writes are executed atomically.

Fields

transaction_id: String

Implementations

impl Transaction

pub async fn get<T: DeserializeOwned>( &self, document_path: &str, ) -> Result<Option<T>, FirestoreError>

Reads the document at the given path.

The read is performed as part of the transaction.

Arguments

• document_path - The path to the document to read.

pub fn set<T: Serialize>( &self, document_path: &str, value: &T, ) -> Result<&Self, FirestoreError>

Overwrites the document referred to by document_path.

If the document does not exist, it will be created. If it does exist, it will be overwritten.

Arguments

• document_path - The path to the document to write.
• value - The data to write.

pub fn update<T: Serialize>( &self, document_path: &str, value: &T, ) -> Result<&Self, FirestoreError>

Updates fields in the document referred to by document_path.

If the document does not exist, the transaction will fail.

Arguments

• document_path - The path to the document to update.
• value - The data to update.

pub fn delete(&self, document_path: &str) -> Result<&Self, FirestoreError>

Deletes the document referred to by document_path.

Arguments

• document_path - The path to the document to delete.

Trait Implementations

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.