blob: a55459703d0b19c3c5910037ee9a7410be3ee8bb (
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
87
88
89
|
/*
* 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>
#include <memory>
#include "Firestore/Source/Local/StringView.h"
#include "Firestore/core/src/firebase/firestore/local/leveldb_transaction.h"
#include "leveldb/db.h"
NS_ASSUME_NONNULL_BEGIN
@class GPBMessage;
/**
* A group of writes that will be applied together atomically to persistent storage.
*
* This class is usable by both Objective-C and Objective-C++ clients. Objective-C clients are able
* to create a new group and commit it. Objective-C++ clients can additionally add to the group
* using deleteKey: and putKey:value:.
*
* Note that this is a write "group" even though the underlying LevelDB concept is a write "batch"
* because Firestore already has a concept of mutation batches, which are user-specified groups of
* changes. This means that an FSTWriteGroup may contain the application of multiple user-specified
* mutation batches.
*/
@interface FSTWriteGroup : NSObject
/**
* Creates a new, empty write group.
*
* @param action A description of the action performed by this group, used for logging.
*/
+ (instancetype)groupWithAction:(NSString *)action;
+ (instancetype)groupWithAction:(NSString *)action
transaction:(firebase::firestore::local::LevelDbTransaction *)transaction;
- (instancetype)init __attribute__((unavailable("Use a static constructor instead")));
/** The action description assigned to this write group. */
@property(nonatomic, copy, readonly) NSString *action;
@property(nonatomic, readonly) firebase::firestore::local::LevelDbTransaction *transaction;
/**
* Marks the given key for deletion.
*
* @param key The LevelDB key of the row to delete
*/
- (void)removeMessageForKey:(Firestore::StringView)key;
/**
* Sets the row identified by the given key to the value of the given protocol buffer message.
*
* @param key The LevelDB Key of the row to set.
* @param message The protocol buffer message whose serialized contents should be used for the
* value associated with the key.
*/
- (void)setMessage:(GPBMessage *)message forKey:(Firestore::StringView)key;
/**
* Sets the row identified by the given key to the value of the given data bytes.
*
* @param key The LevelDB Key of the row to set.
* @param data The exact value to be associated with the key.
*/
- (void)setData:(Firestore::StringView)data forKey:(Firestore::StringView)key;
/** Returns YES if the write group has no messages in it. */
- (BOOL)isEmpty;
@end
NS_ASSUME_NONNULL_END
|
