uni20::display Namespace Reference

Namespaces
namespace	format
namespace	width

Classes
struct	column_format
	Default formatting and styling for values emitted in a streaming table column. More...
struct	column_width
	Schema-level width request for a streaming display table column. More...
struct	event
	Human-facing display event routed through the active sink. More...
struct	format_string
	Compile-time checked display format string with call-site metadata. More...
struct	formatted_cell
	Already formatted display text with numeric alignment semantics retained by its producer. More...
class	scoped_sink
	Temporarily replace the display sink and restore it on destruction. More...
class	streaming_table
	Schema-first table for progress output where rows are emitted immediately. More...

Typedefs
template<typename... Args>
using	checked_format_string = std::type_identity_t< format_string< Args... > >
	Non-deduced format-string parameter type used by display helper templates.
using	event_content = std::variant< presentation::styled_text, presentation::report_builder >
	Presentation payload carried to a display sink before final rendering.
using	sink = std::function< void(event const &)>
	Callable that receives display events for final routing and rendering.

Enumerations
enum class	column_value_kind { automatic , text , number }
	Semantic value type expected by a streaming table column. More...
enum class	column_width_mode { fixed , share , fit }
	Width allocation mode for a streaming display table column. More...
enum class	stream { out , err }
	Selects the ordinary display stream for a message. More...

Functions
sink	current_sink ()
	Return a copy of the active display sink.
template<typename... Args>
void	deferred (checked_format_string< Args... > format, Args &&... args)
	Emit an intentionally deferred display message.
void	emit (presentation::report_builder report, stream destination=stream::err, bool newline=true, std::source_location where=std::source_location::current())
	Emit a presentation report through the active display sink.
void	emit (presentation::styled_text text, stream destination=stream::err, bool newline=true, std::source_location where=std::source_location::current())
	Emit styled text through the active display sink.
template<typename... Args>
void	failure (checked_format_string< Args... > format, Args &&... args)
	Emit a failure display message.
template<typename... Args>
void	fatal (checked_format_string< Args... > format, Args &&... args)
	Emit a fatal-status display message.
template<typename... Args>
void	info (checked_format_string< Args... > format, Args &&... args)
	Emit an informational display message.
template<typename... Args>
void	partial (checked_format_string< Args... > format, Args &&... args)
	Emit a partially-completed display message.
void	reset_sink ()
	Restore the default C++ terminal display sink.
void	set_sink (sink replacement)
	Replace the process-wide display sink.
template<typename... Args>
void	skipped (checked_format_string< Args... > format, Args &&... args)
	Emit a skipped/unavailable display message.
template<typename... Args>
void	status (presentation::semantic_glyph glyph, checked_format_string< Args... > format, Args &&... args)
	Emit a semantic status message through the active display sink.
template<typename... Args>
presentation::styled_text	status_cell (presentation::semantic_glyph glyph, checked_format_string< Args... > format, Args &&... args)
	Build styled status text without emitting it.
template<typename... Args>
void	success (checked_format_string< Args... > format, Args &&... args)
	Emit a successful/completed display message.
streaming_table	table (std::string title={}, stream destination=stream::out)
	Create a schema-first streaming display table.
template<typename... Args>
void	warning (checked_format_string< Args... > format, Args &&... args)
	Emit a non-fatal warning display message.

Typedef Documentation

checked_format_string

template<typename... Args>

using uni20::display::checked_format_string = typedef std::type_identity_t<format_string<Args...> >

Non-deduced format-string parameter type used by display helper templates.

event_content

using uni20::display::event_content = typedef std::variant<presentation::styled_text, presentation::report_builder>

Presentation payload carried to a display sink before final rendering.

sink

using uni20::display::sink = typedef std::function<void(event const&)>

Callable that receives display events for final routing and rendering.

Enumeration Type Documentation

column_value_kind

enum class uni20::display::column_value_kind

strong

Semantic value type expected by a streaming table column.

Enumerator
automatic
text
number

column_width_mode

enum class uni20::display::column_width_mode

strong

Width allocation mode for a streaming display table column.

Enumerator
fixed
share
fit

stream

enum class uni20::display::stream

strong

Selects the ordinary display stream for a message.

Enumerator
out
err

Function Documentation

current_sink()

sink uni20::display::current_sink

(

)

Return a copy of the active display sink.

deferred()

template<typename... Args>

void uni20::display::deferred	(	checked_format_string< Args... >	format,
		Args &&...	args
	)

Emit an intentionally deferred display message.

emit() [1/2]

void uni20::display::emit	(	presentation::report_builder	report,
		stream	destination,
		bool	newline,
		std::source_location	where
	)

Emit a presentation report through the active display sink.

emit() [2/2]

void uni20::display::emit	(	presentation::styled_text	text,
		stream	destination,
		bool	newline,
		std::source_location	where
	)

Emit styled text through the active display sink.

failure()

template<typename... Args>

void uni20::display::failure	(	checked_format_string< Args... >	format,
		Args &&...	args
	)

Emit a failure display message.

fatal()

template<typename... Args>

void uni20::display::fatal	(	checked_format_string< Args... >	format,
		Args &&...	args
	)

Emit a fatal-status display message.

info()

template<typename... Args>

void uni20::display::info	(	checked_format_string< Args... >	format,
		Args &&...	args
	)

Emit an informational display message.

partial()

template<typename... Args>

void uni20::display::partial	(	checked_format_string< Args... >	format,
		Args &&...	args
	)

Emit a partially-completed display message.

reset_sink()

void uni20::display::reset_sink

(

)

Restore the default C++ terminal display sink.

set_sink()

void uni20::display::set_sink

(

sink

replacement

)

Replace the process-wide display sink.

skipped()

template<typename... Args>

void uni20::display::skipped	(	checked_format_string< Args... >	format,
		Args &&...	args
	)

Emit a skipped/unavailable display message.

status()

template<typename... Args>

void uni20::display::status	(	presentation::semantic_glyph	glyph,
		checked_format_string< Args... >	format,
		Args &&...	args
	)

Emit a semantic status message through the active display sink.

status_cell()

template<typename... Args>

presentation::styled_text uni20::display::status_cell	(	presentation::semantic_glyph	glyph,
		checked_format_string< Args... >	format,
		Args &&...	args
	)

Build styled status text without emitting it.

success()

template<typename... Args>

void uni20::display::success	(	checked_format_string< Args... >	format,
		Args &&...	args
	)

Emit a successful/completed display message.

table()

streaming_table uni20::display::table	(	std::string	title,
		stream	destination
	)

Create a schema-first streaming display table.

warning()

template<typename... Args>

void uni20::display::warning	(	checked_format_string< Args... >	format,
		Args &&...	args
	)

Emit a non-fatal warning display message.