pub struct SourceFileSection {
pub scopes: Vec<Scope>,
pub labels: Vec<Label>,
}Fields§
§scopes: Vec<Scope>§labels: Vec<Label>Implementations§
Source§impl SourceFileSection
impl SourceFileSection
pub fn new() -> Self
pub fn calculate_source_lines_that_must_be_shown(&self) -> Vec<usize>
Sourcepub fn calculate_max_overlapping_scopes(scopes: &[Scope]) -> usize
pub fn calculate_max_overlapping_scopes(scopes: &[Scope]) -> usize
Calculates the maximum number of overlapping scope items for the source block Needed for the padding
Sourcepub fn write_source_line_with_prefixes(
prefix_info: &PrefixInfo<'_>,
labels: &[&Label],
source_line: &str,
writer: impl Write,
) -> Result<()>
pub fn write_source_line_with_prefixes( prefix_info: &PrefixInfo<'_>, labels: &[&Label], source_line: &str, writer: impl Write, ) -> Result<()>
Sourcepub fn write_start_of_line_prefix(
prefix: &PrefixInfo<'_>,
writer: impl Write,
) -> Result<()>
pub fn write_start_of_line_prefix( prefix: &PrefixInfo<'_>, writer: impl Write, ) -> Result<()>
The mandatory prefix for each line. The line number and active scopes.
§Errors
Sourcepub fn write_underlines_for_upcoming_labels(
prefix_info: &PrefixInfo<'_>,
line_labels: &[&Label],
writer: impl Write,
) -> Result<()>
pub fn write_underlines_for_upcoming_labels( prefix_info: &PrefixInfo<'_>, line_labels: &[&Label], writer: impl Write, ) -> Result<()>
Underlines spans for upcoming labels to reference.
§Errors
Sourcepub fn write_labels(
prefix_info: &PrefixInfo<'_>,
line_labels: &[&Label],
writer: impl Write,
) -> Result<()>
pub fn write_labels( prefix_info: &PrefixInfo<'_>, line_labels: &[&Label], writer: impl Write, ) -> Result<()>
Writes the line labels
§Errors
Sourcepub fn write_text_for_ending_scopes(
prefix_info: &PrefixInfo<'_>,
active_scopes: &[&Scope],
line_number: usize,
writer: impl Write,
) -> Result<()>
pub fn write_text_for_ending_scopes( prefix_info: &PrefixInfo<'_>, active_scopes: &[&Scope], line_number: usize, writer: impl Write, ) -> Result<()>
Writes the description for scopes that have ended
§Errors
Trait Implementations§
Auto Trait Implementations§
impl Freeze for SourceFileSection
impl RefUnwindSafe for SourceFileSection
impl Send for SourceFileSection
impl Sync for SourceFileSection
impl Unpin for SourceFileSection
impl UnwindSafe for SourceFileSection
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);