A read-only, non-owning view of a BSON document.
More...
#include <view.hpp>
A read-only, non-owning view of a BSON document.
◆ view() [1/2]
bsoncxx::v_noabi::document::view::view |
( |
| ) |
|
Default constructs a view.
The resulting view will be initialized to point at an empty BSON document.
◆ view() [2/2]
bsoncxx::v_noabi::document::view::view |
( |
const std::uint8_t * |
data, |
|
|
std::size_t |
length |
|
) |
| |
Constructs a view from a buffer.
The caller is responsible for ensuring that the lifetime of the resulting view is a subset of the buffer's.
- Parameters
-
data | A buffer containing a valid BSON document. |
length | The size of the buffer, in bytes. |
◆ begin()
◆ cbegin()
◆ cend()
◆ data()
const std::uint8_t* bsoncxx::v_noabi::document::view::data |
( |
| ) |
const |
Access the raw bytes of the underlying document.
- Returns
- A (non-owning) pointer to the view's buffer.
◆ empty()
bool bsoncxx::v_noabi::document::view::empty |
( |
| ) |
const |
Checks if the underlying document is empty, i.e.
it is equivalent to the trivial document '{}'.
- Returns
- true if the underlying document is empty.
◆ end()
◆ find()
const_iterator bsoncxx::v_noabi::document::view::find |
( |
stdx::string_view |
key | ) |
const |
Finds the first element of the document with the provided key.
If there is no such element, the past-the-end iterator will be returned. The runtime of find() is linear in the length of the document. This method only searches the top-level document, and will not recurse to any subdocuments.
- Parameters
-
key | The key to search for. |
- Returns
- An iterator to the matching element, if found, or the past-the-end iterator.
◆ length()
std::size_t bsoncxx::v_noabi::document::view::length |
( |
| ) |
const |
Gets the length of the underlying buffer.
- Returns
- The length of the document, in bytes.
◆ operator[]()
element bsoncxx::v_noabi::document::view::operator[] |
( |
stdx::string_view |
key | ) |
const |
Finds the first element of the document with the provided key.
If there is no such element, the invalid document::element will be returned. The runtime of operator[] is linear in the length of the document.
- Parameters
-
key | The key to search for. |
- Returns
- The matching element, if found, or the invalid element.
The documentation for this class was generated from the following file:
- src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/document/view.hpp