Struct View 

pub struct View {
    pub format: OutputFormat,
    pub color: ColorMode,
    pub quiet: bool,
    /* private fields */
}

Available on crate feature view only.

How to present a model. JSON never contains ANSI.

Fields

format: OutputFormat

Pretty or JSON.

color: ColorMode

ANSI policy for pretty output.

quiet: bool

Suppress successful pretty output.

Implementations

impl View

pub const fn new(format: OutputFormat, color: ColorMode) -> Self

Build a view that prints successes.

pub const fn json_layout(self, layout: JsonLayout) -> Self

Lay out JSON output as layout. This beats the environment.

pub const fn json_layout_envs(self, names: &'static [&'static str]) -> Self

Replace the ordered environment names read for the JSON layout. An empty slice disables lookup.

pub fn layout(self) -> JsonLayout

JSON layout: the owner’s choice, then the environment, then the default.

pub const fn styles(self, styles: RenderOptions) -> Self

Take record style, list style, and row separation from styles. Its color and width settings are ignored; the view owns those.

pub const fn quiet(self, quiet: bool) -> Self

Suppress successful pretty output when quiet is set.

pub const fn width(self, width: u16) -> Self

Force an explicit presentation width.

pub const fn automatic_width_buffer(self, columns: u16) -> Self

Override the buffer subtracted from automatically detected widths. Zero disables buffering. Explicit Self::width remains exact.

pub const fn automatic_width_buffer_envs( self, names: &'static [&'static str], ) -> Self

Replace the ordered environment names used for the automatic buffer.

pub const fn minimum_automatic_width(self, columns: u16) -> Self

Set the floor for automatically detected effective widths.

pub const fn fallback_width(self, width: Option<u16>) -> Self

Lay out to width when no width is detected; None disables it.

pub const fn explicit_automatic_width_buffer(self) -> Option<u16>

Explicit automatic-width buffer, when set.

pub const fn automatic_width_buffer_env_names(self) -> &'static [&'static str]

Ordered environment names used for the automatic-width buffer.

pub const fn automatic_width_minimum(self) -> u16

Floor applied only to automatically detected widths.

pub fn capture(self, value: &impl Present) -> Result<Captured>

Render without writing. Tests and alternate transports use this path.

Errors

Returns an error when value does not serialize to JSON.

pub fn show(self, value: &impl Present) -> Result<ExitCode>

Render and write one typed model. Returns its process exit semantics.

Errors

Returns an error when value does not serialize to JSON, or when writing to stdout or stderr fails.

pub fn emit_err(self, bin: &str, message: &str) -> Result<ExitCode>

Emit {bin}: {message} or a JSON error envelope.

Errors

Returns an error when writing to stdout or stderr fails.

Trait Implementations

impl Clone for View

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for View

impl Debug for View

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for View

impl PartialEq for View

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for View