StormByte 3.0.0
C++26 foundation of the StormByte suite
Loading...
Searching...
No Matches
owner.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This is the base for StormByte Suite libraries.
5 *
6 * StormByte original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte source in this repository.
20 * They do not cover other StormByte modules or any third-party material
21 * shipped with this repository (including everything under thirdparty/),
22 * which remains under its own license.
23 *
24 * Neither license grants any patent rights. Any patent licenses required
25 * to use this software or third-party components must be obtained separately
26 * from the patent holders.
27 *
28 * StormByte is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU Lesser General Public License for more details.
32 *
33 * You should have received a copy of the GNU Lesser General Public License
34 * version 3 along with StormByte. If not, see
35 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
36 *
37 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
38 */
39
40#pragma once
41
44
49namespace StormByte {
54 namespace Safe {
59 enum class Status : unsigned char {
63 };
64
69 namespace Detail {
75
81 class STORMBYTE_PUBLIC Owner final {
82 public:
86 Owner() noexcept;
87
91 using Clone = void* (*)(const void*) noexcept;
92
96 using Destroy = void (*)(void*) noexcept;
97
106 Owner(void* state, Clone clone, Destroy destroy);
107
113 Owner(const Owner& other);
114
119 Owner(Owner&& other) noexcept;
120
124 ~Owner() noexcept;
125
131 Owner& operator=(const Owner& other);
132
138 Owner& operator=(Owner&& other) noexcept;
139
145 void* Get() const noexcept;
146
147 private:
148 void* m_state;
149 Clone m_clone;
150 Destroy m_destroy;
151 };
152 }
153
163 }
164
169 namespace Type {
173 template<> struct IsMaybeSafe<Safe::Owner>: std::true_type {};
174 }
175}
void(*)(void *) noexcept Destroy
Creator-module destruction callback.
Definition owner.hxx:96
void * Get() const noexcept
Borrow opaque state for a provider-defined typed facade.
void *(*)(const void *) noexcept Clone
Creator-module deep-copy callback; null reports failure.
Definition owner.hxx:91
Owner() noexcept
Empty owner.
Private helpers.
void ThrowSafeConversionFailure(const char *message)
Throw Base's exception for a failed Safe conversion.
Owned values that cross a DLL without the caller's CRT.
Detail::Owner Owner
Public name for opaque state ownership through provider callbacks.
Definition owner.hxx:162
Status
Result of a collection operation; exceptions never leave its owner callback.
Definition owner.hxx:59
@ Missing
Index or key is absent.
Definition owner.hxx:61
@ Success
Operation completed.
Definition owner.hxx:60
@ Failure
Allocation, copying or comparison failed; no exception crosses the callback.
Definition owner.hxx:62
Root namespace of the StormByte suite.
Octet count. Defined in byte_size.hxx. Forwarded so Type::Numeral can name it.
Recognizes types whose DLL-boundary safety depends on documented provider requirements.
Definition safe.hxx:262
#define STORMBYTE_PUBLIC
Definition visibility.h:52