Opaque unique state and creator-module lifetime callbacks.
More...
#include <StormByte/safe/owner.hxx>
|
| using | Clone = void* (*)(const void*) noexcept |
| | Creator-module deep-copy callback; null reports failure.
|
| using | Destroy = void (*)(void*) noexcept |
| | Creator-module destruction callback.
|
|
| | Owner () noexcept |
| | Empty owner.
|
| | Owner (void *state, Clone clone, Destroy destroy) |
| | Adopt state and callbacks.
|
| | Owner (const Owner &other) |
| | Deep copy in the original module.
|
| | Owner (Owner &&other) noexcept |
| | Transfer state; source becomes empty.
|
| | ~Owner () noexcept |
| | Release exclusively through the original callback.
|
| Owner & | operator= (const Owner &other) |
| | Strong-guarantee deep copy.
|
| Owner & | operator= (Owner &&other) noexcept |
| | Release old state and transfer.
|
| void * | Get () const noexcept |
| | Borrow opaque state for a provider-defined typed facade.
|
Opaque unique state and creator-module lifetime callbacks.
- Note
- The creator and Base must remain loaded until every copy is destroyed.
◆ Clone
Creator-module deep-copy callback; null reports failure.
◆ Destroy
Creator-module destruction callback.
◆ Owner() [1/4]
| StormByte::Safe::Detail::Owner::Owner |
( |
| ) |
|
|
noexcept |
◆ Owner() [2/4]
| StormByte::Safe::Detail::Owner::Owner |
( |
void * | state, |
|
|
Clone | clone, |
|
|
Destroy | destroy ) |
Adopt state and callbacks.
- Parameters
-
| state | Owned state. |
| clone | Provider-module deep-copy callback, or null for move-only ownership. |
| destroy | Provider-module release callback; required when state is non-null. |
- Exceptions
-
◆ Owner() [3/4]
| StormByte::Safe::Detail::Owner::Owner |
( |
const Owner & | other | ) |
|
Deep copy in the original module.
- Parameters
-
- Exceptions
-
◆ Owner() [4/4]
| StormByte::Safe::Detail::Owner::Owner |
( |
Owner && | other | ) |
|
|
noexcept |
Transfer state; source becomes empty.
- Parameters
-
◆ ~Owner()
| StormByte::Safe::Detail::Owner::~Owner |
( |
| ) |
|
|
noexcept |
Release exclusively through the original callback.
◆ Get()
| void * StormByte::Safe::Detail::Owner::Get |
( |
| ) |
const |
|
noexcept |
Borrow opaque state for a provider-defined typed facade.
- Returns
- Borrowed state pointer, or null after move.
- Note
- Invalid after this owner is moved from, replaced or destroyed; do not retain it.
◆ operator=() [1/2]
| Owner & StormByte::Safe::Detail::Owner::operator= |
( |
const Owner & | other | ) |
|
Strong-guarantee deep copy.
- Parameters
-
- Returns
- This owner.
◆ operator=() [2/2]
| Owner & StormByte::Safe::Detail::Owner::operator= |
( |
Owner && | other | ) |
|
|
noexcept |
Release old state and transfer.
- Parameters
-
- Returns
- This owner.
The documentation for this class was generated from the following file: