blob: bb5bb2215c356b390eef5b247662784b767243bf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
/*
* 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"
#include "Firestore/core/src/firebase/firestore/model/document_key.h"
#include "Firestore/core/src/firebase/firestore/model/document_key_set.h"
@class FSTMaybeDocument;
@class FSTQuery;
@protocol FSTMutationQueue;
@protocol FSTRemoteDocumentCache;
NS_ASSUME_NONNULL_BEGIN
/**
* A readonly view of the local state of all documents we're tracking (i.e. we have a cached
* version in remoteDocumentCache or local mutations for the document). The view is computed by
* applying the mutations in the FSTMutationQueue to the FSTRemoteDocumentCache.
*/
@interface FSTLocalDocumentsView : NSObject
+ (instancetype)viewWithRemoteDocumentCache:(id<FSTRemoteDocumentCache>)remoteDocumentCache
mutationQueue:(id<FSTMutationQueue>)mutationQueue;
- (instancetype)init __attribute__((unavailable("Use a static constructor")));
/**
* Get the local view of the document identified by `key`.
*
* @return Local view of the document or nil if we don't have any cached state for it.
*/
- (nullable FSTMaybeDocument *)documentForKey:(const firebase::firestore::model::DocumentKey &)key;
/**
* Gets the local view of the documents identified by `keys`.
*
* If we don't have cached state for a document in `keys`, a FSTDeletedDocument will be stored
* for that key in the resulting set.
*/
- (FSTMaybeDocumentDictionary *)documentsForKeys:
(const firebase::firestore::model::DocumentKeySet &)keys;
/** Performs a query against the local view of all documents. */
- (FSTDocumentDictionary *)documentsMatchingQuery:(FSTQuery *)query;
@end
NS_ASSUME_NONNULL_END
|
