Struct DocumentReference 

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

A reference to a document in a Firestore database.

Implementations

impl<'a> DocumentReference<'a>

pub async fn get(&self) -> Result<DocumentSnapshot<'a>, FirestoreError>

Reads the document referenced by this DocumentReference.

Returns

A Result containing a DocumentSnapshot.

pub fn collection(&self, collection_id: &str) -> CollectionReference<'a>

Gets a CollectionReference instance that refers to the subcollection at the specified path.

pub async fn list_collections( &self, ) -> Result<Vec<CollectionReference<'a>>, FirestoreError>

Lists the subcollections of this document.

pub async fn set<T: Serialize>( &self, value: &T, ) -> Result<WriteResult, FirestoreError>

Writes to the document referred to by this DocumentReference.

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

Arguments

• value - The data to write to the document.

pub async fn update<T: Serialize>( &self, value: &T, update_mask: Option<Vec<String>>, ) -> Result<WriteResult, FirestoreError>

Updates fields in the document referred to by this DocumentReference.

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

Arguments

• value - The data to update.
• update_mask - An optional list of field paths to update. If provided, only the fields in the mask will be updated.

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

Deletes the document referred to by this DocumentReference.

pub async fn listen(&self) -> Result<ListenStream, FirestoreError>

Listens to changes to the document.

Trait Implementations

impl<'a> Clone for DocumentReference<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DocumentReference<'a>

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

Formats the value using the given formatter.