#[non_exhaustive]pub struct HierarchyPathReferenceBuilder { /* private fields */ }
Expand description
A builder for HierarchyPathReference
.
Implementations§
Source§impl HierarchyPathReferenceBuilder
impl HierarchyPathReferenceBuilder
Sourcepub fn level_one(self, input: HierarchyGroupSummaryReference) -> Self
pub fn level_one(self, input: HierarchyGroupSummaryReference) -> Self
Information about level one.
Sourcepub fn set_level_one(
self,
input: Option<HierarchyGroupSummaryReference>,
) -> Self
pub fn set_level_one( self, input: Option<HierarchyGroupSummaryReference>, ) -> Self
Information about level one.
Sourcepub fn get_level_one(&self) -> &Option<HierarchyGroupSummaryReference>
pub fn get_level_one(&self) -> &Option<HierarchyGroupSummaryReference>
Information about level one.
Sourcepub fn level_two(self, input: HierarchyGroupSummaryReference) -> Self
pub fn level_two(self, input: HierarchyGroupSummaryReference) -> Self
Information about level two.
Sourcepub fn set_level_two(
self,
input: Option<HierarchyGroupSummaryReference>,
) -> Self
pub fn set_level_two( self, input: Option<HierarchyGroupSummaryReference>, ) -> Self
Information about level two.
Sourcepub fn get_level_two(&self) -> &Option<HierarchyGroupSummaryReference>
pub fn get_level_two(&self) -> &Option<HierarchyGroupSummaryReference>
Information about level two.
Sourcepub fn level_three(self, input: HierarchyGroupSummaryReference) -> Self
pub fn level_three(self, input: HierarchyGroupSummaryReference) -> Self
Information about level three.
Sourcepub fn set_level_three(
self,
input: Option<HierarchyGroupSummaryReference>,
) -> Self
pub fn set_level_three( self, input: Option<HierarchyGroupSummaryReference>, ) -> Self
Information about level three.
Sourcepub fn get_level_three(&self) -> &Option<HierarchyGroupSummaryReference>
pub fn get_level_three(&self) -> &Option<HierarchyGroupSummaryReference>
Information about level three.
Sourcepub fn level_four(self, input: HierarchyGroupSummaryReference) -> Self
pub fn level_four(self, input: HierarchyGroupSummaryReference) -> Self
Information about level four.
Sourcepub fn set_level_four(
self,
input: Option<HierarchyGroupSummaryReference>,
) -> Self
pub fn set_level_four( self, input: Option<HierarchyGroupSummaryReference>, ) -> Self
Information about level four.
Sourcepub fn get_level_four(&self) -> &Option<HierarchyGroupSummaryReference>
pub fn get_level_four(&self) -> &Option<HierarchyGroupSummaryReference>
Information about level four.
Sourcepub fn level_five(self, input: HierarchyGroupSummaryReference) -> Self
pub fn level_five(self, input: HierarchyGroupSummaryReference) -> Self
Information about level five.
Sourcepub fn set_level_five(
self,
input: Option<HierarchyGroupSummaryReference>,
) -> Self
pub fn set_level_five( self, input: Option<HierarchyGroupSummaryReference>, ) -> Self
Information about level five.
Sourcepub fn get_level_five(&self) -> &Option<HierarchyGroupSummaryReference>
pub fn get_level_five(&self) -> &Option<HierarchyGroupSummaryReference>
Information about level five.
Sourcepub fn build(self) -> HierarchyPathReference
pub fn build(self) -> HierarchyPathReference
Consumes the builder and constructs a HierarchyPathReference
.
Trait Implementations§
Source§impl Clone for HierarchyPathReferenceBuilder
impl Clone for HierarchyPathReferenceBuilder
Source§fn clone(&self) -> HierarchyPathReferenceBuilder
fn clone(&self) -> HierarchyPathReferenceBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for HierarchyPathReferenceBuilder
impl Default for HierarchyPathReferenceBuilder
Source§fn default() -> HierarchyPathReferenceBuilder
fn default() -> HierarchyPathReferenceBuilder
Source§impl PartialEq for HierarchyPathReferenceBuilder
impl PartialEq for HierarchyPathReferenceBuilder
Source§fn eq(&self, other: &HierarchyPathReferenceBuilder) -> bool
fn eq(&self, other: &HierarchyPathReferenceBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for HierarchyPathReferenceBuilder
Auto Trait Implementations§
impl Freeze for HierarchyPathReferenceBuilder
impl RefUnwindSafe for HierarchyPathReferenceBuilder
impl Send for HierarchyPathReferenceBuilder
impl Sync for HierarchyPathReferenceBuilder
impl Unpin for HierarchyPathReferenceBuilder
impl UnwindSafe for HierarchyPathReferenceBuilder
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> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);