parcel::PrimitiveCell< T > Class Template Reference

Leaf cell wrapping a single scalar (or complex) value of type T. More...

#include <primitive.h>

Inheritance diagram for parcel::PrimitiveCell< T >:

Collaboration diagram for parcel::PrimitiveCell< T >:

Public Member Functions
std::string	to_string () const override
	Render the value as a string.
Public Member Functions inherited from parcel::BaseCell< PrimitiveCell< T >, T >
	explicit (false) BaseCell(U &&v)
	Construct by forwarding into the storage (v becomes Storage::value).
PrimitiveCell< T > &	operator= (U &&v)
	Assign to the storage from v.
T &	get ()
	Mutable access to the held storage.
T const &	get () const
	Read-only access to the held storage.
std::partial_ordering	compare (ICell const &other) const override
	Default three-way comparison: kind first, then storage value.
json_t	to_json () const override
	Default JSON serialization for cells with JSON-convertible storage.
void	inject_display_info (json_t &j) const
	Copy this cell's display info (if any) into the JSON object under "d".
Public Member Functions inherited from parcel::ICell
virtual std::string	to_formatted_string () const
	Render the cell as a multi-line, indented string.
virtual std::size_t	hash_value () const noexcept
	Equality-consistent hash that mirrors compare's display-info-insensitivity.
cell_t	with_display_info (DisplayInfo m) const
	Return a deep copy with the entire display info block replaced.
cell_t	with_name (std::string v) const
	Return a deep copy with name set to v.
cell_t	with_description (std::string v) const
	Return a deep copy with description set to v.
cell_t	with_icon (comms::Icon icon) const
	Return a deep copy with icon set to the typed icon.
cell_t	with_icon (std::string const &v) const
	Return a deep copy with icon parsed from an Iconify set:name string (e.g.
cell_t	with_color (comms::Color color) const
	Return a deep copy with color set to the typed color.
cell_t	with_color (std::string const &v) const
	Return a deep copy with color parsed from a color string (hex like "#ffcc00", a CSS-functional form, or a CSS color name).

Static Public Member Functions
static cell_t	from_json (json_t const &j, ParcelRegistry const &)
	Deserialize a PrimitiveCell<T> from JSON.
static cell_type_descriptor_t	descriptor ()
	Cached descriptor for this primitive type.
Static Public Member Functions inherited from parcel::BaseCell< PrimitiveCell< T >, T >
static std::shared_ptr< PrimitiveCell< T > >	of (Args &&... args)
	Construct a shared_ptr<Derived> forwarding the arguments.
static std::unique_ptr< PrimitiveCell< T > >	unique (Args &&... args)
	Construct a unique_ptr<Derived> forwarding the arguments.
static void	absorb_display_info (json_t const &j, Out &out)
	Read "d" (if present) from a JSON object and assign it onto a cell.
static cell_t	from_json_strict (json_t const &j)
	Strict shorthand for the recurring cell_from_json + make_shared.

Static Public Attributes
static constexpr std::string_view	kind_id = trait_t::type_id
	Wire kind id (taken from PrimitiveTraits<T>::type_id).
Static Public Attributes inherited from parcel::ICell
static constexpr std::string_view	KEY_KIND = "k"
	JSON key for the kind id ("k").
static constexpr std::string_view	KEY_VALUE = "v"
	JSON key for the value payload ("v").
static constexpr std::string_view	KEY_DESCRIPTION = "d"
	JSON key for the optional display info block ("d").

Additional Inherited Members
Public Attributes inherited from parcel::BaseCell< PrimitiveCell< T >, T >
T	value
	Held value of the cell.
Static Protected Member Functions inherited from parcel::BaseCell< PrimitiveCell< T >, T >
static T	cell_from_json (const json_t &j, const std::string_view expected_kind)
	Validate a wrapped {"k","v"} JSON object and extract its "v" as T.
Protected Attributes inherited from parcel::BaseCell< PrimitiveCell< T >, T >
std::optional< DisplayInfo >	display_info_
	Optional display info; omitted from JSON when empty.

Detailed Description

template<PrimitiveStorage T>
class parcel::PrimitiveCell< T >

Leaf cell wrapping a single scalar (or complex) value of type T.

Wire shape:

{"k": "<type_id>", "v": <value>}

with <type_id> taken from PrimitiveTraits<T>::type_id (e.g. "i32", "string"). 128-bit integers serialize their "v" as a decimal string and complex numbers as a [real, imaginary] array, via the commons ADL serializers pulled in through json.h.

Template Parameters

T	A type satisfying PrimitiveStorage.

See also

PrimitiveTraits — wire id and default display info per T.

SimpleCellTypeDescriptor — descriptor used by descriptor().

Member Function Documentation

descriptor()

template<PrimitiveStorage T>

static cell_type_descriptor_t parcel::PrimitiveCell< T >::descriptor ( )

inlinestatic

Cached descriptor for this primitive type.

Returns

Shared descriptor instance.

from_json()

template<PrimitiveStorage T>

static cell_t parcel::PrimitiveCell< T >::from_json ( json_t const &  j, ParcelRegistry const &    )

inlinestatic

Deserialize a PrimitiveCell<T> from JSON.

Parameters

j	Input JSON object — must match {"k": kind_id, "v": <value>}.

Returns

Newly built cell handle.

Exceptions

std::runtime_error

on shape or kind mismatch.

to_string()

template<PrimitiveStorage T>

std::string parcel::PrimitiveCell< T >::to_string ( ) const

inlineoverridevirtual

Render the value as a string.

Strings are returned verbatim, bool becomes "true" / "false", char becomes a 1-byte string, 128-bit integers are formatted by hand (since std::to_string has no overload), complex numbers render as "(real, imaginary)", and everything else routes through std::to_string.

Returns

Compact textual form of the value.

Implements parcel::ICell.

---

The documentation for this class was generated from the following file:

• include/parcel/primitive.h