mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
Gil
4fbc96904f
This simplifies the import process back into google3 and allows us to add additional directories to the project without needing to update the project files for each directory we add. This shows up most clearly in the change to Firestore/Example/Firestore.xcodeproj/project.pbxproj: this no longer needs to list essentially every directory in the project as a header search path. * Clang-format configuration for C++ files * Add support C++-only sources to the podspec * Podspec support for fully qualified imports * xcodeproj changes for fully-qualified imports * Use fully-qualified imports in Firestore sources
77 lines
2.5 KiB
Objective-C
77 lines
2.5 KiB
Objective-C
/*
|
|
* Copyright 2017 Google
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import "Firestore/Source/Model/FSTDocumentDictionary.h"
|
|
|
|
@class FSTDocumentKey;
|
|
@class FSTMaybeDocument;
|
|
@class FSTQuery;
|
|
@class FSTWriteGroup;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
* Represents cached documents received from the remote backend.
|
|
*
|
|
* The cache is keyed by FSTDocumentKey and entries in the cache are FSTMaybeDocument instances,
|
|
* meaning we can cache both FSTDocument instances (an actual document with data) as well as
|
|
* FSTDeletedDocument instances (indicating that the document is known to not exist).
|
|
*/
|
|
@protocol FSTRemoteDocumentCache <NSObject>
|
|
|
|
/** Shuts this cache down, closing open files, etc. */
|
|
- (void)shutdown;
|
|
|
|
/**
|
|
* Adds or replaces an entry in the cache.
|
|
*
|
|
* The cache key is extracted from `maybeDocument.key`. If there is already a cache entry for
|
|
* the key, it will be replaced.
|
|
*
|
|
* @param maybeDocument A FSTDocument or FSTDeletedDocument to put in the cache.
|
|
*/
|
|
- (void)addEntry:(FSTMaybeDocument *)maybeDocument group:(FSTWriteGroup *)group;
|
|
|
|
/** Removes the cached entry for the given key (no-op if no entry exists). */
|
|
- (void)removeEntryForKey:(FSTDocumentKey *)documentKey group:(FSTWriteGroup *)group;
|
|
|
|
/**
|
|
* Looks up an entry in the cache.
|
|
*
|
|
* @param documentKey The key of the entry to look up.
|
|
* @return The cached FSTDocument or FSTDeletedDocument entry, or nil if we have nothing cached.
|
|
*/
|
|
- (nullable FSTMaybeDocument *)entryForKey:(FSTDocumentKey *)documentKey;
|
|
|
|
/**
|
|
* Executes a query against the cached FSTDocument entries
|
|
*
|
|
* Implementations may return extra documents if convenient. The results should be re-filtered
|
|
* by the consumer before presenting them to the user.
|
|
*
|
|
* Cached FSTDeletedDocument entries have no bearing on query results.
|
|
*
|
|
* @param query The query to match documents against.
|
|
* @return The set of matching documents.
|
|
*/
|
|
- (FSTDocumentDictionary *)documentsMatchingQuery:(FSTQuery *)query;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|