blob: b5521e73a2f4fca5361f59d52377daf68622f3db (
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*
* 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"
@class FSTDocument;
NS_ASSUME_NONNULL_BEGIN
/**
* DocumentSet is an immutable (copy-on-write) collection that holds documents in order specified
* by the provided comparator. We always add a document key comparator on top of what is provided
* to guarantee document equality based on the key.
*/
@interface FSTDocumentSet : NSObject
/** Creates a new, empty FSTDocumentSet sorted by the given comparator, then by keys. */
+ (instancetype)documentSetWithComparator:(NSComparator)comparator;
- (instancetype)init __attribute__((unavailable("Use a static constructor instead")));
- (NSUInteger)count;
/** Returns true if the dictionary contains no elements. */
- (BOOL)isEmpty;
/** Returns YES if this set contains a document with the given key. */
- (BOOL)containsKey:(const firebase::firestore::model::DocumentKey &)key;
/** Returns the document from this set with the given key if it exists or nil if it doesn't. */
- (FSTDocument *_Nullable)documentForKey:(const firebase::firestore::model::DocumentKey &)key;
/**
* Returns the first document in the set according to its built in ordering, or nil if the set
* is empty.
*/
- (FSTDocument *_Nullable)firstDocument;
/**
* Returns the last document in the set according to its built in ordering, or nil if the set
* is empty.
*/
- (FSTDocument *_Nullable)lastDocument;
/**
* Returns the index of the document with the provided key in the document set. Returns NSNotFound
* if the key is not present.
*/
- (NSUInteger)indexOfKey:(const firebase::firestore::model::DocumentKey &)key;
- (NSEnumerator<FSTDocument *> *)documentEnumerator;
/** Returns a copy of the documents in this set as an array. This is O(n) on the size of the set. */
- (NSArray<FSTDocument *> *)arrayValue;
/**
* Returns the documents as a FSTMaybeDocumentDictionary. This is O(1) as this leverages our
* internal representation.
*/
- (FSTMaybeDocumentDictionary *)dictionaryValue;
/** Returns a new FSTDocumentSet that contains the given document. */
- (instancetype)documentSetByAddingDocument:(FSTDocument *_Nullable)document;
/** Returns a new FSTDocumentSet that excludes any document associated with the given key. */
- (instancetype)documentSetByRemovingKey:(const firebase::firestore::model::DocumentKey &)key;
@end
NS_ASSUME_NONNULL_END
|
