aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firestore/third_party/Immutable/FSTArraySortedDictionaryEnumerator.h
blob: 36c4f32bc726dbcbdfa27323e90ef8e5d164b19b (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
#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

@interface FSTArraySortedDictionaryEnumerator <KeyType, ValueType> : NSEnumerator<ValueType>

- (id)init __attribute__((unavailable("Use initWithKeys:startPos:endPos:isReverse: instead.")));

/**
 * An enumerator for use with a dictionary.
 *
 * @param keys The keys to enumerator within.
 * @param start The index of the initial key to return.
 * @param end If end is after (or equal to) start (or before, if reverse), then the enumerator will
 *            stop and not return the value once it reaches end.
 */
- (instancetype)initWithKeys:(NSArray<KeyType> *)keys
                    startPos:(int)start
                      endPos:(int)end
                   isReverse:(BOOL)reverse NS_DESIGNATED_INITIALIZER;

- (_Nullable ValueType)nextObject;

@end

NS_ASSUME_NONNULL_END