Struct FirestoreWriteResult

pub struct FirestoreWriteResult {
    pub update_time: Option<DateTime<Utc>>,
    pub transform_results: Vec<FirestoreValue>,
}

The result of a Firestore write operation (create, update, delete).

This struct provides information about the outcome of a write, such as the document’s update time and the results of any field transformations that were applied.

Fields

update_time: Option<DateTime<Utc>>

The time at which the document was last updated after this write operation.

This is None if the write operation did not result in a changed document (e.g., deleting a non-existent document, or an update that didn’t change any values).

transform_results: Vec<FirestoreValue>

A list of values that are the result of applying field transformations.

Each FirestoreValue in this list corresponds to a FirestoreFieldTransform applied in the write request. The order of results matches the order of transformations in the request. For example, if an Increment transform was used, this would contain the new value of the incremented field.

Implementations

impl FirestoreWriteResult

pub fn new(transform_results: Vec<FirestoreValue>) -> Self

pub fn update_time(&mut self, value: DateTime<Utc>) -> &mut Self

pub fn reset_update_time(&mut self) -> &mut Self

pub fn mopt_update_time(&mut self, value: Option<DateTime<Utc>>) -> &mut Self

pub fn with_update_time(self, value: DateTime<Utc>) -> Self

pub fn without_update_time(self) -> Self

pub fn opt_update_time(self, value: Option<DateTime<Utc>>) -> Self

pub fn transform_results(&mut self, value: Vec<FirestoreValue>) -> &mut Self

pub fn with_transform_results(self, value: Vec<FirestoreValue>) -> Self

Trait Implementations

impl Clone for FirestoreWriteResult

fn clone(&self) -> FirestoreWriteResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FirestoreWriteResult

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

Formats the value using the given formatter.

impl From<FirestoreWriteResultInit> for FirestoreWriteResult

fn from(value: FirestoreWriteResultInit) -> Self

Converts to this type from the input type.

impl PartialEq for FirestoreWriteResult

fn eq(&self, other: &FirestoreWriteResult) -> 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 TryInto<FirestoreWriteResult> for WriteResult

type Error = FirestoreError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<FirestoreWriteResult, Self::Error>

Performs the conversion.

impl StructuralPartialEq for FirestoreWriteResult