Struct DocumentSnapshot 

pub struct DocumentSnapshot { /* private fields */ }

Snapshot of a document’s contents.

Implementations

impl DocumentSnapshot

pub fn new( key: DocumentKey, data: Option<MapValue>, metadata: SnapshotMetadata, ) -> Self

pub fn exists(&self) -> bool

Returns whether the document exists on the backend.

pub fn data(&self) -> Option<&BTreeMap<String, FirestoreValue>>

Returns the decoded document fields if the snapshot contains data.

The returned map borrows from the snapshot; mutate a clone before writing it back to Firestore.

pub fn metadata(&self) -> &SnapshotMetadata

Returns snapshot metadata describing cache and mutation state.

pub fn map_value(&self) -> Option<&MapValue>

Returns the underlying map value for advanced conversions.

pub fn from_cache(&self) -> bool

Convenience accessor matching the JS API.

pub fn has_pending_writes(&self) -> bool

Convenience accessor matching the JS API.

pub fn id(&self) -> &str

Returns the identifier of the document represented by this snapshot.

pub fn reference( &self, firestore: Firestore, ) -> FirestoreResult<DocumentReference>

Creates a document reference pointing at the same location as this snapshot.

pub fn into_typed<C>(self, converter: Arc<C>) -> TypedDocumentSnapshot<C>

where C: FirestoreDataConverter,

Converts this snapshot into a typed snapshot using the provided converter.

pub fn to_typed<C>(&self, converter: Arc<C>) -> TypedDocumentSnapshot<C>

where C: FirestoreDataConverter,

Returns a typed snapshot by cloning the underlying data and converter.

Trait Implementations

impl Clone for DocumentSnapshot

fn clone(&self) -> DocumentSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentSnapshot

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

Formats the value using the given formatter.