Struct FirestoreUpdateDocObjBuilder

pub struct FirestoreUpdateDocObjBuilder<'a, D>
where
    D: FirestoreUpdateSupport,
{ /* private fields */ }

A builder for specifying the document ID and data for an update operation.

This stage allows setting the document data (as a raw Document or a serializable object), preconditions, field transformations, and which fields to return after the update.

Implementations

impl<'a, D> FirestoreUpdateDocObjBuilder<'a, D>

where D: FirestoreUpdateSupport,

pub fn return_only_fields<I>(self, return_only_fields: I) -> Self

where I: IntoIterator, I::Item: AsRef<str>,

Specifies which fields of the updated document should be returned.

If not set, the entire document is typically returned after the update.

Arguments

• return_only_fields: An iterator of field paths to return.

Returns

The builder instance with the projection mask for the return value set.

pub fn precondition(self, precondition: FirestoreWritePrecondition) -> Self

Specifies a precondition for the update operation.

The update will only be executed if the precondition is met.

Arguments

• precondition: The FirestoreWritePrecondition to apply.

Returns

The builder instance with the precondition set.

pub fn transforms<FN>(self, doc_transform: FN) -> Self

where FN: Fn(FirestoreTransformBuilder) -> Vec<FirestoreFieldTransform>,

Specifies server-side field transformations to apply as part of the update.

The doc_transform argument is a closure that receives a FirestoreTransformBuilder and should return a Vec<FirestoreFieldTransform>.

Arguments

• doc_transform: A closure to build the list of field transformations.

Returns

The builder instance with the field transformations set.

pub fn document( self, document: Document, ) -> FirestoreUpdateDocExecuteBuilder<'a, D>

Specifies the document data to update using a raw Document.

The document.name field should contain the full path to the document.

Arguments

• document: The Firestore Document containing the fields to update.

Returns

A FirestoreUpdateDocExecuteBuilder to execute the operation.

pub fn document_id<S>( self, document_id: S, ) -> FirestoreUpdateObjInitExecuteBuilder<'a, D>

where S: AsRef<str> + Send,

Specifies the ID of the document to update.

This transitions the builder to expect a Rust object for the update data.

Arguments

• document_id: The ID of the document to update.

Returns

A FirestoreUpdateObjInitExecuteBuilder to specify the object and execute.

Trait Implementations

impl<'a, D> Clone for FirestoreUpdateDocObjBuilder<'a, D>

where D: FirestoreUpdateSupport + Clone,

fn clone(&self) -> FirestoreUpdateDocObjBuilder<'a, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, D> Debug for FirestoreUpdateDocObjBuilder<'a, D>

where D: FirestoreUpdateSupport + Debug,

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

Formats the value using the given formatter.