Struct RenderSettings 

#[non_exhaustive]
pub struct RenderSettings {

    pub format: OutputFormat,
    pub format_explicit: bool,
    pub mode: RenderMode,
    pub color: ColorMode,
    pub unicode: UnicodeMode,
    pub width: Option<usize>,
    pub margin: usize,
    pub indent_size: usize,
    pub short_list_max: usize,
    pub medium_list_max: usize,
    pub grid_padding: usize,
    pub grid_columns: Option<usize>,
    pub column_weight: usize,
    pub table_overflow: TableOverflow,
    pub table_border: TableBorderStyle,
    pub help_chrome: HelpChromeSettings,
    pub mreg_stack_min_col_width: usize,
    pub mreg_stack_overflow_ratio: usize,
    pub theme_name: String,
    pub style_overrides: StyleOverrides,
    pub chrome_frame: SectionFrameStyle,
    pub ruled_section_policy: RuledSectionPolicy,
    pub guide_default_format: GuideDefaultFormat,
    pub runtime: RenderRuntime,
    /* private fields */
}

User-configurable settings for rendering CLI output.

This is the durable caller-facing render policy. format, mode, color, and unicode express caller intent; runtime supplies the terminal facts used when any of those stay on Auto. Most embedders should start with RenderSettings::builder, while tests and deterministic snapshots should usually start with RenderSettings::test_plain.

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: OutputFormat

Preferred output format.

format_explicit: bool

Whether format was chosen explicitly by the caller.

mode: RenderMode

Preferred rendering mode.

color: ColorMode

Color behavior selection.

unicode: UnicodeMode

Unicode behavior selection.

width: Option<usize>

Explicit width override for rendering.

margin: usize

Left margin applied to rendered blocks.

indent_size: usize

Indentation width used for nested structures.

short_list_max: usize

Maximum list length rendered in compact form.

medium_list_max: usize

Maximum list length rendered in medium form before expanding further.

grid_padding: usize

Horizontal padding between grid columns.

grid_columns: Option<usize>

Explicit grid column count override.

column_weight: usize

Relative weighting for adaptive grid columns.

table_overflow: TableOverflow

Overflow policy for table cells.

table_border: TableBorderStyle

Border style for general table rendering.

help_chrome: HelpChromeSettings

Help/guide-specific chrome settings.

mreg_stack_min_col_width: usize

Minimum width before stacked MREG columns are used.

mreg_stack_overflow_ratio: usize

Threshold controlling when MREG content overflows into stacked mode.

theme_name: String

Selected theme name.

style_overrides: StyleOverrides

Per-token style overrides layered on top of the theme.

chrome_frame: SectionFrameStyle

Section frame style used for grouped chrome.

ruled_section_policy: RuledSectionPolicy

Placement policy for ruled section separators across sibling sections.

guide_default_format: GuideDefaultFormat

Fallback behavior for semantic guide output.

runtime: RenderRuntime

Runtime terminal facts used during auto-resolution.

Implementations

impl RenderSettings

pub fn resolve_render_settings(&self) -> ResolvedRenderSettings

Resolves terminal-aware rendering settings from the configured preferences.

Plain mode is a strict fallback: once selected, the resolved settings will not emit ANSI color or Unicode box-drawing even if the runtime can.

Examples

use osp_cli::core::output::{ColorMode, OutputFormat, RenderMode, UnicodeMode};
use osp_cli::ui::{RenderBackend, RenderSettings};

let mut settings = RenderSettings::test_plain(OutputFormat::Json);
settings.mode = RenderMode::Auto;
settings.color = ColorMode::Always;
settings.unicode = UnicodeMode::Always;

let resolved = settings.resolve_render_settings();

assert_eq!(resolved.backend, RenderBackend::Rich);
assert!(resolved.color);
assert!(resolved.unicode);

impl RenderSettings

pub fn builder() -> RenderSettingsBuilder

Starts building render settings from the default UI baseline.

Prefer this for real caller-facing render policy. For deterministic docs/tests, RenderSettings::test_plain is usually a better starting point because it disables ANSI and rich terminal inference up front.

pub fn test_plain(format: OutputFormat) -> Self

Shared plain-mode baseline for deterministic tests and examples.

This keeps docs and tests from duplicating a large struct literal every time they need a stable no-color rendering baseline.

Examples

use osp_cli::core::output::OutputFormat;
use osp_cli::ui::{RenderBackend, RenderSettings};

let resolved = RenderSettings::test_plain(OutputFormat::Json)
    .resolve_render_settings();

assert_eq!(resolved.backend, RenderBackend::Plain);
assert!(!resolved.color);
assert!(!resolved.unicode);

pub fn prefers_guide_rendering(&self) -> bool

Returns whether guide output should be preferred for the current settings.

This only falls back to guide mode when the caller did not explicitly request another format.

Examples

use osp_cli::core::output::OutputFormat;
use osp_cli::ui::{GuideDefaultFormat, RenderSettings};

let mut settings = RenderSettings::test_plain(OutputFormat::Auto);
settings.format_explicit = false;
settings.guide_default_format = GuideDefaultFormat::Guide;
assert!(settings.prefers_guide_rendering());

settings.format_explicit = true;
settings.format = OutputFormat::Json;
assert!(!settings.prefers_guide_rendering());

Trait Implementations

impl Clone for RenderSettings

fn clone(&self) -> RenderSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderSettings

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

Formats the value using the given formatter.

impl Default for RenderSettings

fn default() -> Self

Returns the “default value” for a type.