aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firestore/core/src/firebase/firestore/model/snapshot_version.h
blob: dbecea13c6b92ed7d5baa17aff074f531a2af5d7 (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
/*
 * Copyright 2018 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.
 */

#ifndef FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_SNAPSHOT_VERSION_H_
#define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_SNAPSHOT_VERSION_H_

#include "Firestore/core/include/firebase/firestore/timestamp.h"

namespace firebase {
namespace firestore {
namespace model {

/**
 * A version of a document in Firestore. This corresponds to the version
 * timestamp, such as update_time or read_time.
 */
class SnapshotVersion {
 public:
#if __OBJC__
  SnapshotVersion() {
  }
#endif  // __OBJC__

  explicit SnapshotVersion(const Timestamp& timestamp);

  const Timestamp& timestamp() const {
    return timestamp_;
  }

  /** Creates a new version that is smaller than all other versions. */
  static const SnapshotVersion& None();

#if __OBJC__
  size_t Hash() const {
    return std::hash<Timestamp>{}(timestamp_);
  }
#endif  // __OBJC__

 private:
  Timestamp timestamp_;
};

/** Compares against another SnapshotVersion. */
inline bool operator<(const SnapshotVersion& lhs, const SnapshotVersion& rhs) {
  return lhs.timestamp() < rhs.timestamp();
}

inline bool operator>(const SnapshotVersion& lhs, const SnapshotVersion& rhs) {
  return lhs.timestamp() > rhs.timestamp();
}

inline bool operator>=(const SnapshotVersion& lhs, const SnapshotVersion& rhs) {
  return lhs.timestamp() >= rhs.timestamp();
}

inline bool operator<=(const SnapshotVersion& lhs, const SnapshotVersion& rhs) {
  return lhs.timestamp() <= rhs.timestamp();
}

inline bool operator!=(const SnapshotVersion& lhs, const SnapshotVersion& rhs) {
  return lhs.timestamp() != rhs.timestamp();
}

inline bool operator==(const SnapshotVersion& lhs, const SnapshotVersion& rhs) {
  return lhs.timestamp() == rhs.timestamp();
}

}  // namespace model
}  // namespace firestore
}  // namespace firebase

#endif  // FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_SNAPSHOT_VERSION_H_