Enum Probe 

#[non_exhaustive]
pub enum Probe {
    Redirected,
    #[non_exhaustive]
    Terminal {
        columns: Option<u16>,
    },
}

What the operating system says about one stream: redirected away from a terminal, or a terminal of some width.

Terminal::from_probe turns a probe into a decision without touching the process, so a test chooses the probe to use.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Redirected

A pipe, a file, or a closed stream: anything but a terminal.

#[non_exhaustive]

Terminal

A terminal. Build it with Probe::terminal.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

columns: Option<u16>

The window width in cells, when the system reports a non-zero one.

Implementations

impl Probe

pub const fn terminal(columns: Option<u16>) -> Self

A terminal whose window is columns cells wide, or whose width the system does not report, for None. A width of 0 counts as not reported.

pub fn of(stream: Stream) -> Self

Available on crate feature detect only.

What the system says about stream right now. Needs the detect feature.

pub fn is_terminal(self) -> bool

Whether the stream is a terminal, whether or not it reports a width.

pub fn columns(self) -> Option<u16>

The terminal’s width in cells, when it is a terminal that reports one.

Trait Implementations

impl Clone for Probe

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Probe

impl Debug for Probe

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

Formats the value using the given formatter.

impl Eq for Probe

impl Hash for Probe

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Probe

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Probe