Trait IsTerminal 

pub trait IsTerminal: Sealed {
    // Required method
    fn is_terminal(&self) -> bool;
}

Trait to determine if a descriptor/handle refers to a terminal/tty.

Required Methods

fn is_terminal(&self) -> bool

Returns true if the descriptor/handle refers to a terminal/tty.

On platforms where Rust does not know how to detect a terminal yet, this will return false. This will also return false if an unexpected error occurred, such as from passing an invalid file descriptor.

Platform-specific behavior

On Windows, in addition to detecting consoles, this currently uses some heuristics to detect older msys/cygwin/mingw pseudo-terminals based on device name: devices with names starting with msys- or cygwin- and ending in -pty will be considered terminals. Note that this may change in the future.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl IsTerminal for File

fn is_terminal(&self) -> bool

impl IsTerminal for Stderr

fn is_terminal(&self) -> bool

impl IsTerminal for StderrLock<'_>

fn is_terminal(&self) -> bool

impl IsTerminal for Stdin

fn is_terminal(&self) -> bool

impl IsTerminal for StdinLock<'_>

fn is_terminal(&self) -> bool

impl IsTerminal for Stdout

fn is_terminal(&self) -> bool

impl IsTerminal for StdoutLock<'_>

fn is_terminal(&self) -> bool

Implementors