Struct CollectionReference 

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

A reference to a collection in a Firestore database.

Implementations

impl<'a> CollectionReference<'a>

pub fn doc(&self, document_id: &str) -> DocumentReference<'a>

Gets a DocumentReference for the document within the collection with the specified ID.

Arguments

• document_id - The ID of the document.

pub async fn list_documents( &self, ) -> Result<ListDocumentsResponse, FirestoreError>

Lists documents in this collection.

pub async fn add<T: Serialize>( &self, value: &T, ) -> Result<DocumentReference<'a>, FirestoreError>

Adds a new document to this collection with an auto-generated ID.

Arguments

• value - The data to write to the new document.

pub fn where_filter<T: Serialize>( &self, field: &str, op: FieldOperator, value: T, ) -> Result<Query<'a>, FirestoreError>

Creates and returns a new Query with the additional filter.

pub fn order_by(&self, field: &str, direction: Direction) -> Query<'a>

Creates and returns a new Query that’s additionally sorted by the specified field.

pub fn limit(&self, limit: i32) -> Query<'a>

Creates and returns a new Query that only returns the first matching documents.

pub fn offset(&self, offset: i32) -> Query<'a>

Creates and returns a new Query that skips the first matching documents.

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

Listens to changes in the collection.

Trait Implementations

impl<'a> Clone for CollectionReference<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CollectionReference<'a>

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

Formats the value using the given formatter.