parcel::FlagCell Class Reference

Cell wrapping comms::FlagRef. More...

#include <commons.h>

Inheritance diagram for parcel::FlagCell:

Collaboration diagram for parcel::FlagCell:

Public Member Functions
std::string	to_string () const override
	Render the cell's value as a compact human-readable string.
Public Member Functions inherited from parcel::BaseCell< FlagCell, comms::FlagRef >
	explicit (false) BaseCell(U &&v)
	Construct by forwarding into the storage (v becomes Storage::value).
FlagCell &	operator= (U &&v)
	Assign to the storage from v.
comms::FlagRef &	get ()
	Mutable access to the held storage.
comms::FlagRef 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).

Additional Inherited Members
Static Public Member Functions inherited from parcel::BaseCell< FlagCell, comms::FlagRef >
static std::shared_ptr< FlagCell >	of (Args &&... args)
	Construct a shared_ptr<Derived> forwarding the arguments.
static std::unique_ptr< FlagCell >	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.
Public Attributes inherited from parcel::BaseCell< FlagCell, comms::FlagRef >
comms::FlagRef	value
	Held value of the cell.
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").
Static Protected Member Functions inherited from parcel::BaseCell< FlagCell, comms::FlagRef >
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< FlagCell, comms::FlagRef >
std::optional< DisplayInfo >	display_info_
	Optional display info; omitted from JSON when empty.

Detailed Description

Cell wrapping comms::FlagRef.

Wire kind "flag"; value is the flag name.

Decoding resolves the name against comms::GlobalFlagRegistry; an unregistered name throws (commons behavior).

Member Function Documentation

to_string()

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

inlineoverridevirtual

Render the cell's value as a compact human-readable string.

Returns

String form — implementation-defined per cell type.

Implements parcel::ICell.

---

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

• include/parcel/commons.h