Struct RuntimeHints 

pub struct RuntimeHints {
    pub ui_verbosity: UiVerbosity,
    pub debug_level: u8,
    pub format: OutputFormat,
    pub color: ColorMode,
    pub unicode: UnicodeMode,
    pub profile: Option<String>,
    pub terminal: Option<String>,
    pub terminal_kind: RuntimeTerminalKind,
}

Normalized runtime settings loaded from environment variables.

Fields

ui_verbosity: UiVerbosity

Effective UI message verbosity.

debug_level: u8

Effective debug level capped to the supported range.

format: OutputFormat

Effective output format preference.

color: ColorMode

Effective color-mode preference.

unicode: UnicodeMode

Effective Unicode-mode preference.

profile: Option<String>

Active profile identifier, when set.

terminal: Option<String>

Active terminal identifier, when set.

terminal_kind: RuntimeTerminalKind

Effective terminal kind hint.

Implementations

impl RuntimeHints

pub fn new( ui_verbosity: UiVerbosity, debug_level: u8, format: OutputFormat, color: ColorMode, unicode: UnicodeMode, ) -> Self

Creates a fully specified runtime-hint payload with no profile or terminal metadata attached yet.

debug_level is clamped to the supported 0..=3 range.

Examples

use osp_cli::core::output::{ColorMode, OutputFormat, UnicodeMode};
use osp_cli::core::runtime::{RuntimeHints, UiVerbosity};

let hints = RuntimeHints::new(
    UiVerbosity::Info,
    7,
    OutputFormat::Json,
    ColorMode::Always,
    UnicodeMode::Never,
);

assert_eq!(hints.ui_verbosity, UiVerbosity::Info);
assert_eq!(hints.debug_level, 3);
assert_eq!(hints.profile, None);

pub fn from_env() -> Self

Reads runtime hints from the current process environment.

pub fn with_profile(self, profile: Option<String>) -> Self

Replaces the optional active-profile label.

pub fn with_terminal(self, terminal: Option<String>) -> Self

Replaces the optional terminal identifier.

pub fn with_terminal_kind(self, terminal_kind: RuntimeTerminalKind) -> Self

Replaces the terminal-kind hint.

pub fn from_env_iter<I, K, V>(vars: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: AsRef<str>,

Builds runtime hints from arbitrary key-value environment pairs.

Examples

use osp_cli::core::output::{ColorMode, OutputFormat, UnicodeMode};
use osp_cli::core::runtime::{
    ENV_OSP_COLOR, ENV_OSP_DEBUG_LEVEL, ENV_OSP_FORMAT, ENV_OSP_PROFILE,
    ENV_OSP_TERMINAL_KIND, ENV_OSP_UI_VERBOSITY, RuntimeHints,
    RuntimeTerminalKind, UiVerbosity,
};

let hints = RuntimeHints::from_env_iter([
    (ENV_OSP_UI_VERBOSITY, "trace"),
    (ENV_OSP_DEBUG_LEVEL, "7"),
    (ENV_OSP_FORMAT, "json"),
    (ENV_OSP_COLOR, "never"),
    (ENV_OSP_PROFILE, "uio"),
    (ENV_OSP_TERMINAL_KIND, "repl"),
]);

assert_eq!(hints.ui_verbosity, UiVerbosity::Trace);
assert_eq!(hints.debug_level, 3);
assert_eq!(hints.format, OutputFormat::Json);
assert_eq!(hints.color, ColorMode::Never);
assert_eq!(hints.unicode, UnicodeMode::Auto);
assert_eq!(hints.profile.as_deref(), Some("uio"));
assert_eq!(hints.terminal_kind, RuntimeTerminalKind::Repl);

pub fn env_pairs(&self) -> Vec<(&'static str, String)>

Returns this hint set as environment variable pairs suitable for export.

Examples

use osp_cli::core::output::{ColorMode, OutputFormat, UnicodeMode};
use osp_cli::core::runtime::{RuntimeHints, RuntimeTerminalKind, UiVerbosity};

let hints = RuntimeHints::new(
    UiVerbosity::Info,
    2,
    OutputFormat::Json,
    ColorMode::Always,
    UnicodeMode::Never,
)
.with_profile(Some("uio".to_string()))
.with_terminal(Some("xterm-256color".to_string()))
.with_terminal_kind(RuntimeTerminalKind::Cli);
let pairs = hints.env_pairs();

assert!(pairs.iter().any(|(key, value)| *key == "OSP_FORMAT" && value == "json"));
assert!(pairs.iter().any(|(key, value)| *key == "OSP_PROFILE" && value == "uio"));

Trait Implementations

impl Clone for RuntimeHints

fn clone(&self) -> RuntimeHints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeHints

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

Formats the value using the given formatter.

impl Default for RuntimeHints

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RuntimeHints

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RuntimeHints

impl StructuralPartialEq for RuntimeHints