Skip to main content

Style

Struct Style 

Source
pub struct Style { /* private fields */ }
Expand description

Whether styled output is wanted, and the sequences for it.

Construct with Style::for_stderr at the point of use rather than caching one: the decision is cheap, and a cached one taken before a stream was redirected would be wrong.

Implementations§

Source§

impl Style

Source

pub fn for_stderr() -> Self

The style for diagnostics: colour only when stderr is a terminal.

Source

pub fn for_stdout() -> Self

The style for help text, which is printed to stdout when it was asked for and to stderr when it is a refusal.

Source

pub fn plain() -> Self

A style that emits no escape sequences, whatever is attached.

Source

pub fn is_painted(self) -> bool

Whether anything this style produces will differ from plain text.

Read by callers whose whole output is decoration: a summary that nobody is looking at is not worth the two lines it would push a real error off the top of the screen with.

Source

pub fn bold(self, text: &str) -> String

The one word on a line that carries its meaning.

Source

pub fn dim(self, text: &str) -> String

Context that must not compete with what it qualifies.

Source

pub fn red(self, text: &str) -> String

A refusal.

Source

pub fn green(self, text: &str) -> String

An acceptance.

Source

pub fn cyan(self, text: &str) -> String

Something to type.

Trait Implementations§

Source§

impl Clone for Style

Source§

fn clone(&self) -> Style

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 Style

Source§

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

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

impl Copy for Style

Auto Trait Implementations§

§

impl Freeze for Style

§

impl RefUnwindSafe for Style

§

impl Send for Style

§

impl Sync for Style

§

impl Unpin for Style

§

impl UnsafeUnpin for Style

§

impl UnwindSafe for Style

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.