parcel 0.2.4
Wrappable, wire-transferable C++23 value system with JSON serialization
Loading...
Searching...
No Matches
identity.h
Go to the documentation of this file.
1#pragma once
2
8#include <parcel/cell.h>
9#include <parcel/defaults.h>
10#include <parcel/descriptor.h>
11#include <parcel/json.h>
12
13#include <commons/identity.hpp>
14#include <commons/json/identity.hpp>
15
16#include <compare>
17#include <memory>
18#include <optional>
19#include <string>
20#include <string_view>
21#include <utility>
22
23namespace parcel {
24
36class IdentityCell : public ICell {
37public:
38 using storage_t = comms::IdentityPtr;
39
40 static constexpr std::string_view kind_id = "identity";
41
43 comms::IdentityPtr value;
44
45 IdentityCell() = default;
46 explicit IdentityCell(comms::IdentityPtr v) : value(std::move(v)) {}
47
49 static cell_t of(comms::IdentityPtr v) {
50 return std::make_shared<IdentityCell>(std::move(v));
51 }
52
53 [[nodiscard]] std::string_view kind() const override {
54 return kind_id;
55 }
56
57 [[nodiscard]] std::optional<DisplayInfo> const& overridden_display_info() const override {
58 return display_info_;
59 }
60
61 [[nodiscard]] std::string to_string() const override {
62 return value ? std::string{value->kind()} : std::string{"null"};
63 }
64
65 [[nodiscard]] json_t to_json() const override {
66 json_t j{{KEY_KIND, kind_id}, {KEY_VALUE, value}};
67 if (display_info_) {
68 j[KEY_DESCRIPTION] = *display_info_;
69 }
70 return j;
71 }
72
73 [[nodiscard]] cell_t clone() const override {
74 auto c = std::make_shared<IdentityCell>(value ? value->clone() : comms::IdentityPtr{});
75 c->display_info_ = display_info_;
76 return c;
77 }
78
79 [[nodiscard]] std::partial_ordering compare(ICell const& other) const override {
80 if (const auto k_cmp = this->kind() <=> other.kind(); k_cmp != 0) {
81 return k_cmp;
82 }
83 const auto* o = dynamic_cast<IdentityCell const*>(&other);
84 if (o == nullptr) {
85 return std::partial_ordering::unordered;
86 }
87 return json_t(value) == json_t(o->value) ? std::partial_ordering::equivalent
88 : std::partial_ordering::unordered;
89 }
90
91 static cell_t from_json(json_t const& j, ParcelRegistry const&) {
92 if (!j.is_object()) {
93 throw InvalidJsonException("Expected JSON object for ICell", std::string(kind_id));
94 }
95 const auto it_kind = j.find(KEY_KIND);
96 if (it_kind == j.end() || !it_kind->is_string()) {
97 throw InvalidJsonException("Missing or invalid 'k' field in ICell JSON",
98 std::string(kind_id));
99 }
100 if (const auto k = it_kind->get<std::string_view>(); k != kind_id) {
101 throw KindMismatchException("Unexpected kind in ICell JSON: expected '" +
102 std::string(kind_id) + "', got '" + std::string(k) +
103 "'",
104 std::string(kind_id));
105 }
106 const auto it_value = j.find(KEY_VALUE);
107 if (it_value == j.end()) {
108 throw InvalidJsonException("Missing 'v' field in ICell JSON", std::string(kind_id));
109 }
110 // Resolves "kind" against comms::GlobalIdentityRegistry; unknown kind throws.
111 auto cell = std::make_shared<IdentityCell>(it_value->get<comms::IdentityPtr>());
112 if (const auto it_d = j.find(KEY_DESCRIPTION); it_d != j.end()) {
113 cell->set_display_info(it_d->get<DisplayInfo>());
114 }
115 return cell;
116 }
117
118 static cell_type_descriptor_t descriptor() {
119 static const auto d = std::make_shared<SimpleCellTypeDescriptor<IdentityCell>>(DisplayInfo{
120 .name = "Identity",
121 .description = "Polymorphic \"who\" envelope ({\"kind\", …fields} on the wire)"});
122 return d;
123 }
124
125protected:
126 void set_display_info(std::optional<DisplayInfo> m) override {
127 display_info_ = std::move(m);
128 }
129
130private:
131 std::optional<DisplayInfo> display_info_;
132};
133
134} // namespace parcel
135
Core ICell interface, cell_t handle, BaseCell CRTP base, and CellLike concept.
std::shared_ptr< ICellTypeDescriptor > cell_type_descriptor_t
Shared handle to a runtime cell-type descriptor.
Definition cell.h:63
std::shared_ptr< ICell > cell_t
Shared handle to any ICell-derived value — the canonical cell pointer.
Definition cell.h:68
Cell wrapping comms::IdentityPtr (a std::unique_ptr<comms::IIdentity>).
Definition identity.h:36
std::partial_ordering compare(ICell const &other) const override
Three-way compare against another cell.
Definition identity.h:79
std::string_view kind() const override
Wire-stable kind identifier for this cell.
Definition identity.h:53
cell_t clone() const override
Deep-copy this cell.
Definition identity.h:73
std::optional< DisplayInfo > const & overridden_display_info() const override
Read-only access to this cell's optional display info.
Definition identity.h:57
void set_display_info(std::optional< DisplayInfo > m) override
Replace this cell's display info in place.
Definition identity.h:126
comms::IdentityPtr value
Held identity (may be null).
Definition identity.h:43
json_t to_json() const override
Serialize this cell to its canonical JSON representation.
Definition identity.h:65
std::string to_string() const override
Render the cell's value as a compact human-readable string.
Definition identity.h:61
static cell_t of(comms::IdentityPtr v)
Construct a shared_ptr<IdentityCell> owning v.
Definition identity.h:49
JSON shape was wrong (missing/non-string k, missing v, etc.).
Definition error.h:158
Runtime catalog of cell-type descriptors, keyed by wire kind id.
Definition registry.h:115
comms::DisplayInfo DisplayInfo
Display info attached to a cell or descriptor — re-exported from comms::DisplayInfo.
Definition common.h:75
The default_cell_for<T> trait that drives FieldsBuilder field-type inference.
#define PARCEL_DEFAULT_CELL(CellT)
Register a cell type as the default wrapper for its payload type.
Definition defaults.h:269
auto cell(T &&v)
Wrap a raw value into its default cell, returning a shared_ptr to the cell.
Definition defaults.h:192
Runtime cell-type descriptors and the schema-graph mix-ins (IHasFields, ISubTypes).
nlohmann::json typedef shared across cell types.
nlohmann::json json_t
Project-wide alias for nlohmann::json.
Definition json.h:19
Polymorphic root of every parcel cell.
Definition cell.h:84
static constexpr std::string_view KEY_DESCRIPTION
JSON key for the optional display info block ("d").
Definition cell.h:90
static constexpr std::string_view KEY_VALUE
JSON key for the value payload ("v").
Definition cell.h:88
virtual std::string_view kind() const =0
Wire-stable kind identifier for this cell.
static constexpr std::string_view KEY_KIND
JSON key for the kind id ("k").
Definition cell.h:86