Heterogeneous string-keyed map of cell_t — wire kind "m". More...

#include <map.h>

Inheritance diagram for parcel::MapCell:

[legend]

Collaboration diagram for parcel::MapCell:

[legend]

Public Member Functions
	MapCell (const std::initializer_list< std::pair< const std::string, cell_t > > elems)
	Construct from a brace-enclosed list of `{key, cell}` pairs.

auto	keys () const noexcept
	Lazy view over the keys of the map.

auto	values () const noexcept
	Lazy view over the cell values of the map.

std::string	to_string () const override
	Render the map as `{k1: v1, …}`; null values appear as `<null>`.

json_t	to_json () const override
	Default JSON serialization for cells with JSON-convertible storage.

cell_t	clone () const override
	Deep-copy this cell.

std::size_t	hash_value () const noexcept override
	Equality-consistent hash that mirrors `compare`'s display-info-insensitivity.

std::partial_ordering	compare (ICell const &other) const override
	Lexicographic three-way comparison over keys then values; ignores display info.

Public Member Functions inherited from parcel::BaseCell< MapCell, std::map< std::string, cell_t > >
	explicit (false) BaseCell(U &&v)
	Construct by forwarding into the storage (`v` becomes `Storage::value`).

MapCell &	operator= (U &&v)
	Assign to the storage from `v`.

std::map< std::string, cell_t > &	get ()
	Mutable access to the held storage.

std::map< std::string, cell_t > const &	get () const
	Read-only access to the held 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.

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 &reg)
	Deserialize a `MapCell` from JSON.

static cell_type_descriptor_t	descriptor ()
	Cached descriptor for `MapCell`.

Static Public Member Functions inherited from parcel::BaseCell< MapCell, std::map< std::string, cell_t > >
static std::shared_ptr< MapCell >	of (Args &&... args)
	Construct a `shared_ptr<Derived>` forwarding the arguments.

static std::unique_ptr< MapCell >	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 = "m"
	Wire kind id (`"m"`).

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< MapCell, std::map< std::string, cell_t > >
std::map< std::string, cell_t >	value
	Held value of the cell.

Static Protected Member Functions inherited from parcel::BaseCell< MapCell, std::map< std::string, cell_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< MapCell, std::map< std::string, cell_t > >
std::optional< DisplayInfo >	display_info_
	Optional display info; omitted from JSON when empty.

Detailed Description

Heterogeneous string-keyed map of cell_t — wire kind "m".

Wire shape:

{"k": "m", "v": {"a": {"k":"i32","v":1}, "b": {"k":"string","v":"hi"}}}

Values are full nested cells whose kind is recovered from each value's own "k". Use TypedMapCell<T> instead when every value has the same wire kind — the typed variant skips the per-value kind tag.

See also: TypedMapCell — homogeneous variant with element-tagged kind id.

Constructor & Destructor Documentation

◆ MapCell()

parcel::MapCell::MapCell ( const std::initializer_list< std::pair< const std::string, cell_t > > elems )

inline

Construct from a brace-enclosed list of {key, cell} pairs.

Parameters

elems Initializer list of key/cell pairs.

Member Function Documentation

◆ clone()

cell_t parcel::MapCell::clone ( ) const

inlineoverridevirtual

Deep-copy this cell.

Returns: A new cell_t whose state is independent of the original.

Reimplemented from parcel::BaseCell< MapCell, std::map< std::string, cell_t > >.

◆ compare()

std::partial_ordering parcel::MapCell::compare ( ICell const & other ) const

inlineoverridevirtual

Lexicographic three-way comparison over keys then values; ignores display info.

Walks the (sorted) key sequences in lockstep. Null values compare less than non-null at the same key.

Reimplemented from parcel::BaseCell< MapCell, std::map< std::string, cell_t > >.

◆ descriptor()

cell_type_descriptor_t parcel::MapCell::descriptor ( )

inlinestatic

Cached descriptor for MapCell.

Returns: Shared descriptor instance.

◆ from_json()

static cell_t parcel::MapCell::from_json	(	json_t const &	j,
		ParcelRegistry const &	reg
	)

inlinestatic

Deserialize a MapCell from JSON.

Parameters

j	Input JSON object — must match `{"k": "m", "v": {…}}`.
reg	Registry used to dispatch each value by its own kind.

Returns: Newly built cell handle.

Exceptions

std::runtime_error on shape mismatch or unknown value kind.

◆ hash_value()

std::size_t parcel::MapCell::hash_value ( ) const

inlineoverridevirtualnoexcept

Equality-consistent hash that mirrors compare's display-info-insensitivity.

Default implementation hashes the kind id and the JSON dump of "v", which works for every cell whose to_json() payload omits nested DisplayInfo. Heterogeneous container cells (ListCell, MapCell, HashMapCell) override this to recurse through hash_value() on their children — that is what keeps the hash display-info-insensitive when children carry display info of their own.

Reimplemented from parcel::ICell.

◆ to_json()

json_t parcel::MapCell::to_json ( ) const

inlineoverridevirtual

Default JSON serialization for cells with JSON-convertible storage.

If Storage has a JSON adapter, emits {"k": kind_id, "v": value, optional "d": display info}. Otherwise the call throws — the derived cell must override to_json itself (ListCell, MapCell, etc.).

Returns: JSON object representation.

Exceptions

std::runtime_error if Storage is not JSON-convertible.

Reimplemented from parcel::BaseCell< MapCell, std::map< std::string, cell_t > >.

◆ to_string()

std::string parcel::MapCell::to_string ( ) const

inlineoverridevirtual

Render the map as {k1: v1, …}; null values appear as <null>.

Returns: Brace-enclosed comma-separated form.

Implements parcel::ICell.

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

include/parcel/map.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MapCell()

Member Function Documentation

◆ clone()

◆ compare()

◆ descriptor()

◆ from_json()

◆ hash_value()

◆ to_json()

◆ to_string()