Struct TuiEnvironment 

pub struct TuiEnvironment {
    pub stdin_is_terminal: bool,
    pub stdout_is_terminal: bool,
    pub is_ci: bool,
}

Runtime environment details used to decide whether a TUI can run interactively.

Fields

stdin_is_terminal: bool

Whether standard input is connected to a terminal.

stdout_is_terminal: bool

Whether standard output is connected to a terminal.

is_ci: bool

Whether Foundry appears to be running in CI.

Implementations

impl TuiEnvironment

pub const fn new( stdin_is_terminal: bool, stdout_is_terminal: bool, is_ci: bool, ) -> Self

Creates a new environment descriptor.

pub fn detect() -> Self

Detects the current process environment.

pub const fn mode(self) -> TuiMode

Resolves the TUI mode for this environment.

Trait Implementations

impl Clone for TuiEnvironment

fn clone(&self) -> TuiEnvironment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TuiEnvironment

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

Formats the value using the given formatter.

impl PartialEq for TuiEnvironment

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

impl Eq for TuiEnvironment

impl StructuralPartialEq for TuiEnvironment

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 3 bytes