Struct FirestoreCacheCollectionConfiguration 

pub struct FirestoreCacheCollectionConfiguration {
    pub collection_name: String,
    pub parent: Option<String>,
    pub listener_target: FirestoreListenerTarget,
    pub collection_load_mode: FirestoreCacheCollectionLoadMode,
    pub collection_watch: FirestoreCacheCollectionWatch,
    /* private fields */
}

Configuration for a single cached collection.

Fields

collection_name: String

The collection ID, for example users.

parent: Option<String>

An optional parent document path, for caching a sub-collection.

listener_target: FirestoreListenerTarget

The Firestore listener target ID used to keep this collection up to date. It must be unique across every listener in your application, not just within the cache.

collection_load_mode: FirestoreCacheCollectionLoadMode

How this collection is populated at startup, which also determines whether list/query may be served from the cache.

collection_watch: FirestoreCacheCollectionWatch

Which documents of the collection the cache holds and listens to.

Implementations

impl FirestoreCacheCollectionConfiguration

pub fn new<S>( collection_name: S, listener_target: FirestoreListenerTarget, collection_load_mode: FirestoreCacheCollectionLoadMode, ) -> Self

where S: AsRef<str>,

Creates a configuration for a collection.

pub fn listener_target_params( &self, resume_type: Option<FirestoreListenerTargetResumeType>, ) -> FirestoreListenerTargetParams

The listener target that keeps this collection up to date.

Backends use this in load so that a collection limited to named documents is listened to as a documents target rather than as a query over the whole collection.

pub fn listener_read_time() -> FirestoreInstant

The point in time a newly attached listener target should be resumed from.

Deliberately a little behind the local clock: a read time in the server’s future is rejected as invalid, and a client clock can easily run slightly ahead. The cost is a few redundant document changes, which are idempotent.

pub fn with_documents<I>(self, document_ids: I) -> Self

where I: IntoIterator, I::Item: AsRef<str>,

Caches and listens to only these documents of the collection, instead of all of them.

pub fn watched_document_ids(&self) -> Option<&[String]>

The document IDs this collection is limited to, if any.

pub fn with_parent<S>(self, parent: S) -> Self

where S: AsRef<str>,

Caches a sub-collection under the given parent document path.

Use FirestoreDb::parent_path to build the parent.

Trait Implementations

impl Clone for FirestoreCacheCollectionConfiguration

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FirestoreCacheCollectionConfiguration

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

Formats the value using the given formatter.

impl From<FirestoreCacheCollectionConfiguration> for FirestoreCacheCollection

fn from(config: FirestoreCacheCollectionConfiguration) -> Self

Converts to this type from the input type.