Struct tiny_firestore_odm::Collection

pub struct Collection<T> where
    T: Serialize + DeserializeOwned + 'static,  { /* fields omitted */ }

Represents a collection of documents in a Firestore database.

Documents in Firestore do not have types, but on the Rust end, we associate each collection with a type. Documents are serialized into and deserialized from this type when writing/reading to Firestore.

Implementations

impl<T> Collection<T> where
    T: Serialize + DeserializeOwned + Unpin, 

pub fn new(db: SharedFirestoreClient, name: CollectionName) -> Self

Construct a top-level collection (i.e. a collection whose parent is the root.)

pub fn list(&self) -> ListResponse<T>

Returns a stream of all of the documents in a collection (as NamedDocuments).

pub async fn create_with_key(
    &self,
    ob: &T,
    key: impl QualifyDocumentName
) -> Result<()>

Create the given document in this collection with the given key. Returns an error if the key is already in use (if you intend to replace the document in that case, use upsert instead.)

pub async fn try_create(
    &self,
    ob: &T,
    key: impl QualifyDocumentName
) -> Result<bool>

Create the given document in this collection with the given key. Returns true if the document was created, or false if it already existed.

pub async fn create(&self, ob: &T) -> Result<DocumentName>

Add the given document to this collection, assigning it a new key at random.

pub async fn upsert(&self, ob: &T, key: impl QualifyDocumentName) -> Result<()>

Overwrite the given document to this collection, creating a new document if one does not exist.

pub async fn update(&self, ob: &T, key: impl QualifyDocumentName) -> Result<()>

Update the given document, returning an error if it does not exist.

pub async fn get(&self, key: impl QualifyDocumentName) -> Result<T>

Get the document with a given key.

pub async fn delete(&self, key: impl QualifyDocumentName) -> Result<()>

Delete the document with a given key.