Skip to main content

TerminalEnv

Struct TerminalEnv 

Source
pub struct TerminalEnv {
    pub term: Option<String>,
    pub term_program: Option<String>,
    pub lang: Option<String>,
    pub lc_all: Option<String>,
    pub lc_ctype: Option<String>,
    pub no_unicode: Option<String>,
    pub no_rich_unicode: Option<String>,
}
Expand description

Terminal environment inputs the capability probe reads.

The verdict is a pure function of this snapshot, so callers that need to evaluate a hypothetical environment can do so without mutating the process environment.

Fields§

§term: Option<String>

TERM — the terminal’s generic capability string.

§term_program: Option<String>

TERM_PROGRAM — the terminal program’s own name.

§lang: Option<String>

LANG — the primary locale.

§lc_all: Option<String>

LC_ALL — the locale override.

§lc_ctype: Option<String>

LC_CTYPE — the character-encoding locale.

§no_unicode: Option<String>

VTCODE_NO_UNICODE — opt out of Unicode chrome.

§no_rich_unicode: Option<String>

VTCODE_NO_RICH_UNICODE — opt out of the dashed box-drawing variants.

Implementations§

Source§

impl TerminalEnv

Source

pub fn capture() -> Self

Snapshot the current process environment.

Source

pub fn no_unicode_requested(&self) -> bool

Whether the user asked for ASCII-only chrome.

Uses the repository’s canonical env-flag semantics: only an affirmative value (1, true, yes, on, debug) disables Unicode, so VTCODE_NO_UNICODE=0 leaves Unicode chrome enabled.

Source

pub fn no_rich_unicode_requested(&self) -> bool

Whether the user asked to skip the dashed box-drawing variants.

Source

pub fn supports_unicode_box_drawing(&self) -> bool

Whether the terminal can draw Unicode box-drawing glyphs.

TERM is authoritative because it describes the terminal program; the locale only decides the question when TERM says nothing. A UTF-8 locale is the only positive evidence left, so without one the answer stays at “no” and the terminal keeps ASCII chrome.

Source

pub fn supports_rich_box_drawing(&self) -> bool

Whether the terminal renders the dashed box-drawing variants correctly.

TERM_PROGRAM identifies the terminal program; TERM only names it for the terminals that put their name in TERM as well.

Trait Implementations§

Source§

impl Clone for TerminalEnv

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TerminalEnv

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TerminalEnv

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for TerminalEnv

Source§

impl PartialEq for TerminalEnv

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TerminalEnv

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more