MongoDB C++ Driver  mongocxx-3.6.2
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
oid.hpp
1 // Copyright 2014 MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <array>
18 #include <ctime>
19 #include <string>
20 
21 #include <bsoncxx/stdx/string_view.hpp>
22 
23 #include <bsoncxx/config/prelude.hpp>
24 
25 namespace bsoncxx {
26 BSONCXX_INLINE_NAMESPACE_BEGIN
27 
38 class BSONCXX_API oid {
39  public:
40  static constexpr std::size_t k_oid_length = 12;
41 
45  oid();
46 
57  explicit oid(const char* bytes, std::size_t len);
58 
68  explicit oid(const bsoncxx::stdx::string_view& str);
69 
75  std::string to_string() const;
76 
82  static std::size_t size() {
83  return k_oid_length;
84  }
85 
93  friend BSONCXX_API bool BSONCXX_CALL operator<(const oid& lhs, const oid& rhs);
94  friend BSONCXX_API bool BSONCXX_CALL operator>(const oid& lhs, const oid& rhs);
95  friend BSONCXX_API bool BSONCXX_CALL operator<=(const oid& lhs, const oid& rhs);
96  friend BSONCXX_API bool BSONCXX_CALL operator>=(const oid& lhs, const oid& rhs);
97  friend BSONCXX_API bool BSONCXX_CALL operator==(const oid& lhs, const oid& rhs);
98  friend BSONCXX_API bool BSONCXX_CALL operator!=(const oid& lhs, const oid& rhs);
102 
108  std::time_t get_time_t() const;
109 
115  const char* bytes() const;
116 
117  private:
118  friend BSONCXX_PRIVATE int oid_compare(const oid& lhs, const oid& rhs);
119 
120  std::array<char, k_oid_length> _bytes;
121 };
122 
123 BSONCXX_INLINE_NAMESPACE_END
124 } // namespace bsoncxx
125 
126 #include <bsoncxx/config/postlude.hpp>
bsoncxx::oid::oid
oid(const bsoncxx::stdx::string_view &str)
Constructs an oid and initializes it from the provided hex string.
bsoncxx
Top level namespace for MongoDB C++ BSON functionality.
Definition: element.hpp:24
bsoncxx::oid::operator<
friend bool operator<(const oid &lhs, const oid &rhs)
Relational operators for OIDs.
bsoncxx::oid::operator>
friend bool operator>(const oid &lhs, const oid &rhs)
Relational operators for OIDs.
bsoncxx::oid::operator!=
friend bool operator!=(const oid &lhs, const oid &rhs)
Relational operators for OIDs.
bsoncxx::oid::operator==
friend bool operator==(const oid &lhs, const oid &rhs)
Relational operators for OIDs.
bsoncxx::oid::bytes
const char * bytes() const
An accessor for the internal data buffer in the oid.
bsoncxx::oid
Represents a MongoDB ObjectId.
Definition: oid.hpp:38
bsoncxx::oid::get_time_t
std::time_t get_time_t() const
Extracts the timestamp portion of the underlying ObjectId.
bsoncxx::oid::oid
oid()
Constructs an oid and initializes it to a newly generated ObjectId.
bsoncxx::oid::to_string
std::string to_string() const
Converts this oid to a hexadecimal string.
bsoncxx::oid::operator<=
friend bool operator<=(const oid &lhs, const oid &rhs)
Relational operators for OIDs.
bsoncxx::oid::oid
oid(const char *bytes, std::size_t len)
Constructs an oid initializes it to the contents of the provided buffer.
bsoncxx::oid::size
static std::size_t size()
Returns the number of bytes in this ObjectId.
Definition: oid.hpp:82
bsoncxx::oid::operator>=
friend bool operator>=(const oid &lhs, const oid &rhs)
Relational operators for OIDs.