Represents a MongoDB ObjectId.
More...
#include <oid.hpp>
|
| oid () |
| Constructs an oid and initializes it to a newly generated ObjectId.
|
|
| oid (const char *bytes, std::size_t len) |
| Constructs an oid initializes it to the contents of the provided buffer. More...
|
|
| oid (const stdx::string_view &str) |
| Constructs an oid and initializes it from the provided hex string. More...
|
|
std::string | to_string () const |
| Converts this oid to a hexadecimal string. More...
|
|
std::time_t | get_time_t () const |
| Extracts the timestamp portion of the underlying ObjectId. More...
|
|
const char * | bytes () const |
| An accessor for the internal data buffer in the oid. More...
|
|
|
static std::size_t | size () |
| Returns the number of bytes in this ObjectId. More...
|
|
bool | operator< (const oid &lhs, const oid &rhs) |
| Relational operators for OIDs.
|
|
bool | operator> (const oid &lhs, const oid &rhs) |
| Relational operators for OIDs.
|
|
bool | operator<= (const oid &lhs, const oid &rhs) |
| Relational operators for OIDs.
|
|
bool | operator>= (const oid &lhs, const oid &rhs) |
| Relational operators for OIDs.
|
|
bool | operator== (const oid &lhs, const oid &rhs) |
| Relational operators for OIDs.
|
|
bool | operator!= (const oid &lhs, const oid &rhs) |
| Relational operators for OIDs.
|
|
Represents a MongoDB ObjectId.
As this BSON type is used within the MongoDB server as a primary key for each document, it is useful for representing a 'pointer' to another document.
- Note
- we use 'oid' to refer to this concrete class. We use 'ObjectId' to refer to the BSON type.
- See also
- https://www.mongodb.com/docs/manual/reference/object-id/
◆ oid() [1/2]
bsoncxx::v_noabi::oid::oid |
( |
const char * |
bytes, |
|
|
std::size_t |
len |
|
) |
| |
|
explicit |
Constructs an oid initializes it to the contents of the provided buffer.
- Parameters
-
bytes | A pointer a buffer containing a valid ObjectId. |
len | The length of the buffer. Should be equal to oid::size(). |
- Exceptions
-
◆ oid() [2/2]
bsoncxx::v_noabi::oid::oid |
( |
const stdx::string_view & |
str | ) |
|
|
explicit |
Constructs an oid and initializes it from the provided hex string.
- Parameters
-
str | A string of a hexadecimal representation of a valid ObjectId. |
- Exceptions
-
◆ bytes()
const char* bsoncxx::v_noabi::oid::bytes |
( |
| ) |
const |
An accessor for the internal data buffer in the oid.
- Returns
- A pointer to the internal buffer holding the oid bytes.
◆ get_time_t()
std::time_t bsoncxx::v_noabi::oid::get_time_t |
( |
| ) |
const |
Extracts the timestamp portion of the underlying ObjectId.
- Returns
- A std::time_t initialized to the timestamp.
◆ size()
static std::size_t bsoncxx::v_noabi::oid::size |
( |
| ) |
|
|
inlinestatic |
Returns the number of bytes in this ObjectId.
- Returns
- The length of this oid's buffer.
◆ to_string()
std::string bsoncxx::v_noabi::oid::to_string |
( |
| ) |
const |
Converts this oid to a hexadecimal string.
- Returns
- A hexadecimal string representation of this ObjectId.
The documentation for this class was generated from the following file:
- src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/oid.hpp