#[non_exhaustive]pub struct ReferenceLineLabelConfiguration {
pub value_label_configuration: Option<ReferenceLineValueLabelConfiguration>,
pub custom_label_configuration: Option<ReferenceLineCustomLabelConfiguration>,
pub font_configuration: Option<FontConfiguration>,
pub font_color: Option<String>,
pub horizontal_position: Option<ReferenceLineLabelHorizontalPosition>,
pub vertical_position: Option<ReferenceLineLabelVerticalPosition>,
}
Expand description
The label configuration of a reference line.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.value_label_configuration: Option<ReferenceLineValueLabelConfiguration>
The value label configuration of the label in a reference line.
custom_label_configuration: Option<ReferenceLineCustomLabelConfiguration>
The custom label configuration of the label in a reference line.
font_configuration: Option<FontConfiguration>
The font configuration of the label in a reference line.
font_color: Option<String>
The font color configuration of the label in a reference line.
horizontal_position: Option<ReferenceLineLabelHorizontalPosition>
The horizontal position configuration of the label in a reference line. Choose one of the following options:
-
LEFT
-
CENTER
-
RIGHT
vertical_position: Option<ReferenceLineLabelVerticalPosition>
The vertical position configuration of the label in a reference line. Choose one of the following options:
-
ABOVE
-
BELOW
Implementations§
Source§impl ReferenceLineLabelConfiguration
impl ReferenceLineLabelConfiguration
Sourcepub fn value_label_configuration(
&self,
) -> Option<&ReferenceLineValueLabelConfiguration>
pub fn value_label_configuration( &self, ) -> Option<&ReferenceLineValueLabelConfiguration>
The value label configuration of the label in a reference line.
Sourcepub fn custom_label_configuration(
&self,
) -> Option<&ReferenceLineCustomLabelConfiguration>
pub fn custom_label_configuration( &self, ) -> Option<&ReferenceLineCustomLabelConfiguration>
The custom label configuration of the label in a reference line.
Sourcepub fn font_configuration(&self) -> Option<&FontConfiguration>
pub fn font_configuration(&self) -> Option<&FontConfiguration>
The font configuration of the label in a reference line.
Sourcepub fn font_color(&self) -> Option<&str>
pub fn font_color(&self) -> Option<&str>
The font color configuration of the label in a reference line.
Sourcepub fn horizontal_position(
&self,
) -> Option<&ReferenceLineLabelHorizontalPosition>
pub fn horizontal_position( &self, ) -> Option<&ReferenceLineLabelHorizontalPosition>
The horizontal position configuration of the label in a reference line. Choose one of the following options:
-
LEFT
-
CENTER
-
RIGHT
Sourcepub fn vertical_position(&self) -> Option<&ReferenceLineLabelVerticalPosition>
pub fn vertical_position(&self) -> Option<&ReferenceLineLabelVerticalPosition>
The vertical position configuration of the label in a reference line. Choose one of the following options:
-
ABOVE
-
BELOW
Source§impl ReferenceLineLabelConfiguration
impl ReferenceLineLabelConfiguration
Sourcepub fn builder() -> ReferenceLineLabelConfigurationBuilder
pub fn builder() -> ReferenceLineLabelConfigurationBuilder
Creates a new builder-style object to manufacture ReferenceLineLabelConfiguration
.
Trait Implementations§
Source§impl Clone for ReferenceLineLabelConfiguration
impl Clone for ReferenceLineLabelConfiguration
Source§fn clone(&self) -> ReferenceLineLabelConfiguration
fn clone(&self) -> ReferenceLineLabelConfiguration
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for ReferenceLineLabelConfiguration
impl PartialEq for ReferenceLineLabelConfiguration
Source§fn eq(&self, other: &ReferenceLineLabelConfiguration) -> bool
fn eq(&self, other: &ReferenceLineLabelConfiguration) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ReferenceLineLabelConfiguration
Auto Trait Implementations§
impl Freeze for ReferenceLineLabelConfiguration
impl RefUnwindSafe for ReferenceLineLabelConfiguration
impl Send for ReferenceLineLabelConfiguration
impl Sync for ReferenceLineLabelConfiguration
impl Unpin for ReferenceLineLabelConfiguration
impl UnwindSafe for ReferenceLineLabelConfiguration
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>
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);