Struct DisplayOptions 

#[non_exhaustive]
pub struct DisplayOptions {
    pub format: DisplayFormat,
    pub columns: Vec<Column>,
    pub wrap: bool,
    pub sections: Vec<Section>,
    pub metrics: Vec<&'static str>,
    pub section_line_limit: usize,
}

Aggregate display options for the renderer. Plumbed as a single struct through write_diff so a future addition lands in one place without growing every signature. The show-side entry (write_show in src/bin/ktstr.rs) keeps a flatter signature for historical reasons but mirrors the same field semantics — --wrap, --sections, --metrics reach show via wrap / sections / metrics parameters that share the same helpers (new_wrapped_table, Section::cli_name).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

format: DisplayFormat

Format shorthand. Default DisplayFormat::Full.

columns: Vec<Column>

User-supplied column override; empty Vec means “use the format’s default column set.” Set via parse_columns.

wrap: bool

When true, tables render with comfy-table’s [comfy_table::ContentArrangement::Dynamic] layout (terminal-width-aware cell wrapping). When false, tables render with ContentArrangement::Disabled — the prior shape, where columns can spill past the terminal edge. Default false keeps existing operator workflows untouched until the flag is opted into.

sections: Vec<Section>

User-supplied section filter; empty Vec means “render every section that has data” — the unfiltered default. Non-empty restricts the rendered output to the listed sections only. Set via parse_sections.

metrics: Vec<&'static str>

User-supplied per-metric row filter; empty Vec means “render every metric in the primary + derived sections” — the unfiltered default. Non-empty restricts the rendered rows to the listed metric names (which must be in CTPROF_METRICS or CTPROF_DERIVED_METRICS). Set via parse_metrics.

Distinct from Self::sections: sections gate whole sub-tables (primary, derived, cgroup-stats, …); metrics gate individual ROWS within the primary and derived sub-tables. The two compose — naming --sections primary and --metrics run_time_ns shows a single primary row.

section_line_limit: usize

Maximum rendered lines per section. Sections whose table output exceeds this limit are truncated with a notice. 0 means unlimited (no truncation). Populated from the CLI --limit arg (default 500); the struct’s Default is 0 (unlimited).

Implementations

impl DisplayOptions

pub fn resolved_compare_columns(&self) -> Vec<Column>

Resolved compare-side column set: columns if non-empty, otherwise compare_columns_for over format. --columns always wins over the format shorthand (explicit > shorthand) per the design call.

pub fn resolved_show_columns(&self) -> Vec<Column>

Resolved show-side column set: columns if non-empty, otherwise show_columns_default.

pub fn is_section_enabled(&self, section: Section) -> bool

Returns true when section should render under the current filter. Empty sections means “every section renders” (the default — no filter applied), matching parse_sections’s empty-input semantic. Non-empty sections restricts rendering to the named entries.

pub fn is_metric_enabled(&self, name: &str) -> bool

Returns true when the metric named name should render under the current row-level filter. Empty metrics means “every metric renders” — the unfiltered default mirroring Self::is_section_enabled. Non-empty restricts rendering to the listed names. The comparison is on the metric’s &'static str name (so a registry-name pointer or any byte-equal string both match).

pub fn new_table(&self) -> Table

Construct a comfy-table builder honouring the wrap flag: terminal-width-aware Dynamic arrangement when wrap is true, otherwise the existing borderless, disabled-arrangement layout via crate::cli::new_table. Single source of truth so every section in write_diff honours --wrap without per-call-site if branching. The show-side renderer (write_show in src/bin/ktstr.rs) calls the underlying helpers directly through the same branch.

pub fn new_constrained_table(&self, max_widths: &[u16]) -> Table

Create a table constrained to the given max content widths. Heading rows wider than data get auto-truncated by comfy_table with its built-in “…” indicator.

Trait Implementations

impl Clone for DisplayOptions

fn clone(&self) -> DisplayOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayOptions

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

Formats the value using the given formatter.

impl Default for DisplayOptions

fn default() -> DisplayOptions

Returns the “default value” for a type.