Represents a MongoDB ObjectId. More...

#include <oid.hpp>

Public Member Functions
	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 bsoncxx::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 Public Member Functions
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.

Detailed Description

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://docs.mongodb.com/manual/reference/object-id/

Constructor & Destructor Documentation

◆ oid() [1/2]

bsoncxx::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

bsoncxx::exception if the length is not equal to oid::size().

◆ oid() [2/2]

bsoncxx::oid::oid ( const bsoncxx::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

bsoncxx::exception if the string isn't an OID-sized hex string.

Member Function Documentation

◆ bytes()

const char* bsoncxx::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::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::oid::size ( )

inlinestatic

Returns the number of bytes in this ObjectId.

Returns: The length of this oid's buffer.

◆ to_string()

std::string bsoncxx::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/oid.hpp

Public Member Functions

Static Public Member Functions