Struct WriteBatch 

pub struct WriteBatch<'a> { /* private fields */ }

Represents a Firestore Write Batch.

specific set of writes can be performed atomically.

Examples

let batch = firestore.batch();
let user1 = json!({"name": "User 1"});
let user2_updates = json!({"name": "User 2 Updated"});

batch.set("users/user1", &user1)?;
batch.update("users/user2", &user2_updates)?;
batch.delete("users/user3")?;
batch.commit().await?;

Implementations

impl<'a> WriteBatch<'a>

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 operation 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.

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

Creates a document at the given path.

If the document already exists, the operation will fail.

Arguments

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

pub async fn commit(&self) -> Result<Vec<WriteResult>, FirestoreError>

Commits the batch of writes.

Trait Implementations

impl<'a> Clone for WriteBatch<'a>

fn clone(&self) -> WriteBatch<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.