pub struct ReportBuilder<'a, S>where
S: Span,{ /* private fields */ }Expand description
A type used to build a Report.
Implementations§
Source§impl<'a, S> ReportBuilder<'a, S>where
S: Span,
impl<'a, S> ReportBuilder<'a, S>where
S: Span,
Sourcepub fn with_code<C>(self, code: C) -> ReportBuilder<'a, S>where
C: Display,
pub fn with_code<C>(self, code: C) -> ReportBuilder<'a, S>where
C: Display,
Give this report a numerical code that may be used to more precisely look up the error in documentation.
Sourcepub fn set_message<M>(&mut self, msg: M)where
M: ToString,
pub fn set_message<M>(&mut self, msg: M)where
M: ToString,
Set the message of this report.
Sourcepub fn with_message<M>(self, msg: M) -> ReportBuilder<'a, S>where
M: ToString,
pub fn with_message<M>(self, msg: M) -> ReportBuilder<'a, S>where
M: ToString,
Add a message to this report.
Sourcepub fn with_notes<N>(&mut self, notes: N)where
N: IntoIterator<Item = impl ToString>,
pub fn with_notes<N>(&mut self, notes: N)where
N: IntoIterator<Item = impl ToString>,
Removes all notes in this report.
Sourcepub fn with_note<N>(self, note: N) -> ReportBuilder<'a, S>where
N: ToString,
pub fn with_note<N>(self, note: N) -> ReportBuilder<'a, S>where
N: ToString,
Set the note of this report.
Sourcepub fn with_helps<N>(&mut self, helps: N)where
N: IntoIterator<Item = impl ToString>,
pub fn with_helps<N>(&mut self, helps: N)where
N: IntoIterator<Item = impl ToString>,
Set the help messages of this report.
Sourcepub fn with_help<N>(self, note: N) -> ReportBuilder<'a, S>where
N: ToString,
pub fn with_help<N>(self, note: N) -> ReportBuilder<'a, S>where
N: ToString,
Set the help message of this report.
Sourcepub fn add_labels<L>(&mut self, labels: L)where
L: IntoIterator<Item = Label<S>>,
pub fn add_labels<L>(&mut self, labels: L)where
L: IntoIterator<Item = Label<S>>,
Add multiple labels to the report.
Sourcepub fn with_label(self, label: Label<S>) -> ReportBuilder<'a, S>
pub fn with_label(self, label: Label<S>) -> ReportBuilder<'a, S>
Add a label to the report.
Sourcepub fn with_labels<L>(self, labels: L) -> ReportBuilder<'a, S>where
L: IntoIterator<Item = Label<S>>,
pub fn with_labels<L>(self, labels: L) -> ReportBuilder<'a, S>where
L: IntoIterator<Item = Label<S>>,
Add multiple labels to the report.
Sourcepub fn with_config(self, config: Config) -> ReportBuilder<'a, S>
pub fn with_config(self, config: Config) -> ReportBuilder<'a, S>
Use the given Config to determine diagnostic attributes.
Sourcepub fn with_stacktrace(
self,
stacktrace: Vec<StackFrame<S>>,
) -> ReportBuilder<'a, S>
pub fn with_stacktrace( self, stacktrace: Vec<StackFrame<S>>, ) -> ReportBuilder<'a, S>
Add a stack trace to the report.
Trait Implementations§
Auto Trait Implementations§
impl<'a, S> Freeze for ReportBuilder<'a, S>where
S: Freeze,
impl<'a, S> RefUnwindSafe for ReportBuilder<'a, S>where
S: RefUnwindSafe,
impl<'a, S> Send for ReportBuilder<'a, S>where
S: Send,
impl<'a, S> Sync for ReportBuilder<'a, S>where
S: Sync,
impl<'a, S> Unpin for ReportBuilder<'a, S>where
S: Unpin,
impl<'a, S> UnwindSafe for ReportBuilder<'a, S>where
S: 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> 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>
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);