pub struct DiagnosticCode<D = DefaultDiscriminant> {
pub discriminant: D,
/* private fields */
}Expand description
A code that identifies a given kind of diagnostic.
These are meant to be used by users as unchanging identifiers by which they can look up more detailed information about the diagnostic.
Fields§
§discriminant: DThe numeric discriminant.
Implementations§
Source§impl<D> DiagnosticCode<D>
impl<D> DiagnosticCode<D>
Sourcepub fn new(prefix: [u8; 3], discriminant: D) -> Result<Self, Utf8Error>
pub fn new(prefix: [u8; 3], discriminant: D) -> Result<Self, Utf8Error>
Constructs a new DiagnosticCode.
§Errors
If prefix is not valid UTF-8, an error variant will be returned.
§See Also
Sourcepub const unsafe fn new_unchecked(prefix: [u8; 3], discriminant: D) -> Self
pub const unsafe fn new_unchecked(prefix: [u8; 3], discriminant: D) -> Self
Constructs a new DiagnosticCode.
§Safety
The caller is responsible for ensuring prefix is valid UTF-8. For a safe alternative, see
new.
§See Also
Sourcepub const fn prefix_bytes(&self) -> &[u8; 3]
pub const fn prefix_bytes(&self) -> &[u8; 3]
Sourcepub const fn prefix_str(&self) -> &str
pub const fn prefix_str(&self) -> &str
Trait Implementations§
Source§impl<D: Clone> Clone for DiagnosticCode<D>
impl<D: Clone> Clone for DiagnosticCode<D>
Source§fn clone(&self) -> DiagnosticCode<D>
fn clone(&self) -> DiagnosticCode<D>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<D: Debug> Debug for DiagnosticCode<D>
impl<D: Debug> Debug for DiagnosticCode<D>
Source§impl<D> Display for DiagnosticCode<D>where
D: Discriminant,
impl<D> Display for DiagnosticCode<D>where
D: Discriminant,
Source§impl<D: Hash> Hash for DiagnosticCode<D>
impl<D: Hash> Hash for DiagnosticCode<D>
Source§impl<D: Ord> Ord for DiagnosticCode<D>
impl<D: Ord> Ord for DiagnosticCode<D>
Source§fn cmp(&self, other: &DiagnosticCode<D>) -> Ordering
fn cmp(&self, other: &DiagnosticCode<D>) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl<D: PartialEq> PartialEq for DiagnosticCode<D>
impl<D: PartialEq> PartialEq for DiagnosticCode<D>
Source§impl<D: PartialOrd> PartialOrd for DiagnosticCode<D>
impl<D: PartialOrd> PartialOrd for DiagnosticCode<D>
impl<D: Copy> Copy for DiagnosticCode<D>
impl<D: Eq> Eq for DiagnosticCode<D>
impl<D> StructuralPartialEq for DiagnosticCode<D>
Auto Trait Implementations§
impl<D> Freeze for DiagnosticCode<D>where
D: Freeze,
impl<D> RefUnwindSafe for DiagnosticCode<D>where
D: RefUnwindSafe,
impl<D> Send for DiagnosticCode<D>where
D: Send,
impl<D> Sync for DiagnosticCode<D>where
D: Sync,
impl<D> Unpin for DiagnosticCode<D>where
D: Unpin,
impl<D> UnsafeUnpin for DiagnosticCode<D>where
D: UnsafeUnpin,
impl<D> UnwindSafe for DiagnosticCode<D>where
D: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);