Stores some $document metadata from when the document is fetched.
More...
#include <document_metadata.hxx>
|
| | document_metadata (boost::optional< std::string > cas, boost::optional< std::string > revid, boost::optional< std::uint32_t > exptime, boost::optional< std::string > crc32) |
| | Create document metadata, given results of a kv operation. More...
|
| |
| CB_NODISCARD boost::optional< std::string > | cas () const |
| | Get CAS for the document. More...
|
| |
| CB_NODISCARD boost::optional< std::string > | revid () const |
| | Get revid for the document. More...
|
| |
| CB_NODISCARD boost::optional< std::uint32_t > | exptime () const |
| | Get the expiry of the document, if set. More...
|
| |
| CB_NODISCARD boost::optional< std::string > | crc32 () const |
| | Get the crc for the document. More...
|
| |
Stores some $document metadata from when the document is fetched.
◆ document_metadata()
| couchbase::transactions::document_metadata::document_metadata |
( |
boost::optional< std::string > |
cas, |
|
|
boost::optional< std::string > |
revid, |
|
|
boost::optional< std::uint32_t > |
exptime, |
|
|
boost::optional< std::string > |
crc32 |
|
) |
| |
|
inline |
Create document metadata, given results of a kv operation.
- Stability
- Internal:
We expect this constructor to become private soon.
◆ cas()
| CB_NODISCARD boost::optional<std::string> couchbase::transactions::document_metadata::cas |
( |
| ) |
const |
|
inline |
Get CAS for the document.
- Returns
- the CAS of the document, as a string.
◆ crc32()
| CB_NODISCARD boost::optional<std::string> couchbase::transactions::document_metadata::crc32 |
( |
| ) |
const |
|
inline |
Get the crc for the document.
- Returns
- the crc-32 for the document, as a string
◆ exptime()
| CB_NODISCARD boost::optional<std::uint32_t> couchbase::transactions::document_metadata::exptime |
( |
| ) |
const |
|
inline |
Get the expiry of the document, if set.
- Returns
- the expiry of the document, if one was set, and the request specified it.
◆ revid()
| CB_NODISCARD boost::optional<std::string> couchbase::transactions::document_metadata::revid |
( |
| ) |
const |
|
inline |
Get revid for the document.
- Returns
- the revid of the document, as a string.
The documentation for this class was generated from the following file:
