Struct FirestoreCacheConfiguration 

pub struct FirestoreCacheConfiguration {
    pub collections: HashMap<String, FirestoreCacheCollectionConfiguration>,
    pub incomplete_collection_policy: FirestoreCacheIncompleteCollectionPolicy,
}

Describes which collections a FirestoreCache holds and how each of them is loaded.

Collections are keyed by their absolute document path (for example projects/my-project/databases/(default)/documents/users), which is why building a configuration needs a FirestoreDb to resolve the project and database.

You normally do not construct this directly — the cache builder (FirestoreCache::memory / FirestoreCache::persistent) builds it for you.

Fields

collections: HashMap<String, FirestoreCacheCollectionConfiguration>

The configured collections, keyed by absolute collection path.

incomplete_collection_policy: FirestoreCacheIncompleteCollectionPolicy

Controls whether collections that are not fully preloaded may serve list/query requests from the cache. See FirestoreCacheIncompleteCollectionPolicy.

Implementations

impl FirestoreCacheConfiguration

pub fn new() -> Self

Creates an empty configuration.

pub fn add_collection_config( self, db: &FirestoreDb, config: FirestoreCacheCollectionConfiguration, ) -> Self

Adds a collection to the configuration.

The db reference is used to resolve the collection’s absolute path.

pub fn with_incomplete_collection_policy( self, incomplete_collection_policy: FirestoreCacheIncompleteCollectionPolicy, ) -> Self

Sets the policy for collections that are not fully preloaded.

pub fn target_change_action( &self, target_change: &TargetChange, ) -> FirestoreCacheTargetChangeAction

Decides what a Firestore target change means for the collections of this cache.

A backend’s on_listen_event should act on this rather than interpreting the target change itself: it resolves Firestore’s “empty target IDs means all targets” rule, and scopes the result to the documents a target actually covers.

pub fn is_document_cached( &self, collection_path: &str, document_id: &str, ) -> bool

Whether the cache holds this document: its collection is cached, and the collection is not restricted to a different set of document IDs.

pub fn is_collection_listable(&self, collection_path: &str) -> bool

Returns true when the cache is configured to hold a complete copy of the collection at collection_path, meaning list and query requests may be served from the cache.

Only preloaded collections (PreloadAllDocs / PreloadAllIfEmpty) qualify. A PreloadNone collection holds an arbitrary subset of documents — whatever happens to have been read through it so far — so serving a listing from it would silently return partial results.

This can be relaxed with FirestoreCacheIncompleteCollectionPolicy::PartialResults.

Trait Implementations

impl Clone for FirestoreCacheConfiguration

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 FirestoreCacheConfiguration

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

Formats the value using the given formatter.

impl Default for FirestoreCacheConfiguration

fn default() -> Self

Returns the “default value” for a type.