Skip to main content

ConsoleTheme

Struct ConsoleTheme 

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

Color theme for console error output.

The fields are &'static str ANSI escapes — no allocation per construction, and const-constructible for the three preset constructors (ConsoleTheme::with_colors, ConsoleTheme::plain).

Implementations§

Source§

impl ConsoleTheme

Source

pub fn new() -> Self

Create a new theme with default colors. Auto-detects terminal color support; falls back to Self::plain if stderr is not a TTY, TERM=dumb, or NO_COLOR is set.

Source

pub const fn with_colors() -> Self

Create a new theme with colors forced on, regardless of terminal detection.

Source

pub const fn plain() -> Self

Create a new theme with no colors (plain text). Useful for piping output to a file or non-TTY consumer.

Source

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

Format an error message with the error color.

Source

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

Format a warning message with the warning color.

Source

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

Format an info message with the info color.

Source

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

Format a success message with the success color.

Source

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

Format a caption with the caption color.

Source

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

Format text as bold.

Source

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

Format text as dim.

Source

pub fn format_error<E: ForgeError>(&self, err: &E) -> String

Format an error display in a structured way.

Writes the caption, the error’s Display output, the retryability marker, and the optional source chain into a single String buffer. Allocates exactly once.

Trait Implementations§

Source§

impl Default for ConsoleTheme

Source§

fn default() -> Self

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

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> 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, 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<E> WithErrorCode<E> for E

Source§

fn with_code(self, code: impl Into<String>) -> CodedError<E>

Attach an error code to an error
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