Struct InteractiveRuntime 

#[non_exhaustive]
pub struct InteractiveRuntime {
    pub stdin_is_tty: bool,
    pub stderr_is_tty: bool,
    pub terminal: Option<String>,
}

Interactive runtime hints used to decide whether live terminal UI is safe.

This mirrors the render/runtime split elsewhere in osp-ui: callers can inject explicit values for tests or special hosts, while detect() remains the boring default for normal CLI entrypoints.

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.

stdin_is_tty: bool

Whether stdin is attached to a terminal.

stderr_is_tty: bool

Whether stderr is attached to a terminal.

terminal: Option<String>

Detected terminal identifier such as xterm-256color.

Implementations

impl InteractiveRuntime

pub fn new( stdin_is_tty: bool, stderr_is_tty: bool, terminal: Option<String>, ) -> Self

Creates explicit interactive runtime hints.

pub fn detect() -> Self

Detect interactive terminal capabilities from the current process.

pub fn allows_prompting(&self) -> bool

Returns true when both stdin and stderr can support interactive prompts.

Examples

use osp_cli::ui::InteractiveRuntime;

let runtime = InteractiveRuntime::new(
    true,
    true,
    Some("xterm-256color".to_string()),
);

assert!(runtime.allows_prompting());

pub fn allows_live_output(&self) -> bool

Returns true when transient terminal output such as spinners is safe to show.

Examples

use osp_cli::ui::InteractiveRuntime;

let runtime = InteractiveRuntime::new(true, true, Some("dumb".to_string()));

assert!(!runtime.allows_live_output());

Trait Implementations

impl Clone for InteractiveRuntime

fn clone(&self) -> InteractiveRuntime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InteractiveRuntime

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

Formats the value using the given formatter.

impl Default for InteractiveRuntime

fn default() -> InteractiveRuntime

Returns the “default value” for a type.

impl PartialEq for InteractiveRuntime

fn eq(&self, other: &InteractiveRuntime) -> 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 InteractiveRuntime

impl StructuralPartialEq for InteractiveRuntime