Options for collection#decrement().
More...
#include <couchbase/decrement_options.hxx>
|
struct | built |
| Immutable value object representing consistent options. More...
|
|
Options for collection#decrement().
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ build()
auto build |
( |
| ) |
const -> built
|
|
inlinenodiscard |
Validates options and returns them as an immutable value.
- Returns
- consistent options as an immutable value
- Exceptions
-
- Since
- 1.0.0
- Internal
- Internal interface
◆ delta()
The amount of which the document value should be decremented.
- Parameters
-
delta | the amount to decrement. |
- Returns
- this options class for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ expiry() [1/2]
Sets the expiry for the document.
By default the document will never expire.
The duration must be less than 50 years. For expiry further in the future, use expiry(std::chrono::system_clock::time_point)
.
- Parameters
-
duration | the duration after which the document will expire (zero duration means never expire). |
- Returns
- this options class for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ expiry() [2/2]
auto expiry |
( |
std::chrono::system_clock::time_point | time_point | ) |
-> decrement_options&
|
|
inline |
Sets the expiry for the document.
By default the document will never expire.
- Parameters
-
time_point | the point in time when the document will expire (epoch second zero means never expire). |
- Returns
- this options class for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ initial()
The initial value that should be used if the document has not been created yet.
- Parameters
-
value | the initial value to use. |
- Returns
- this options class for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
The documentation for this struct was generated from the following file: