#[non_exhaustive]pub struct ReferenceLineBuilder { /* private fields */ }
Expand description
A builder for ReferenceLine
.
Implementations§
Source§impl ReferenceLineBuilder
impl ReferenceLineBuilder
Sourcepub fn status(self, input: WidgetStatus) -> Self
pub fn status(self, input: WidgetStatus) -> Self
The status of the reference line. Choose one of the following options:
-
ENABLE
-
DISABLE
Sourcepub fn set_status(self, input: Option<WidgetStatus>) -> Self
pub fn set_status(self, input: Option<WidgetStatus>) -> Self
The status of the reference line. Choose one of the following options:
-
ENABLE
-
DISABLE
Sourcepub fn get_status(&self) -> &Option<WidgetStatus>
pub fn get_status(&self) -> &Option<WidgetStatus>
The status of the reference line. Choose one of the following options:
-
ENABLE
-
DISABLE
Sourcepub fn data_configuration(self, input: ReferenceLineDataConfiguration) -> Self
pub fn data_configuration(self, input: ReferenceLineDataConfiguration) -> Self
The data configuration of the reference line.
This field is required.Sourcepub fn set_data_configuration(
self,
input: Option<ReferenceLineDataConfiguration>,
) -> Self
pub fn set_data_configuration( self, input: Option<ReferenceLineDataConfiguration>, ) -> Self
The data configuration of the reference line.
Sourcepub fn get_data_configuration(&self) -> &Option<ReferenceLineDataConfiguration>
pub fn get_data_configuration(&self) -> &Option<ReferenceLineDataConfiguration>
The data configuration of the reference line.
Sourcepub fn style_configuration(self, input: ReferenceLineStyleConfiguration) -> Self
pub fn style_configuration(self, input: ReferenceLineStyleConfiguration) -> Self
The style configuration of the reference line.
Sourcepub fn set_style_configuration(
self,
input: Option<ReferenceLineStyleConfiguration>,
) -> Self
pub fn set_style_configuration( self, input: Option<ReferenceLineStyleConfiguration>, ) -> Self
The style configuration of the reference line.
Sourcepub fn get_style_configuration(
&self,
) -> &Option<ReferenceLineStyleConfiguration>
pub fn get_style_configuration( &self, ) -> &Option<ReferenceLineStyleConfiguration>
The style configuration of the reference line.
Sourcepub fn label_configuration(self, input: ReferenceLineLabelConfiguration) -> Self
pub fn label_configuration(self, input: ReferenceLineLabelConfiguration) -> Self
The label configuration of the reference line.
Sourcepub fn set_label_configuration(
self,
input: Option<ReferenceLineLabelConfiguration>,
) -> Self
pub fn set_label_configuration( self, input: Option<ReferenceLineLabelConfiguration>, ) -> Self
The label configuration of the reference line.
Sourcepub fn get_label_configuration(
&self,
) -> &Option<ReferenceLineLabelConfiguration>
pub fn get_label_configuration( &self, ) -> &Option<ReferenceLineLabelConfiguration>
The label configuration of the reference line.
Sourcepub fn build(self) -> ReferenceLine
pub fn build(self) -> ReferenceLine
Consumes the builder and constructs a ReferenceLine
.
Trait Implementations§
Source§impl Clone for ReferenceLineBuilder
impl Clone for ReferenceLineBuilder
Source§fn clone(&self) -> ReferenceLineBuilder
fn clone(&self) -> ReferenceLineBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ReferenceLineBuilder
impl Debug for ReferenceLineBuilder
Source§impl Default for ReferenceLineBuilder
impl Default for ReferenceLineBuilder
Source§fn default() -> ReferenceLineBuilder
fn default() -> ReferenceLineBuilder
Source§impl PartialEq for ReferenceLineBuilder
impl PartialEq for ReferenceLineBuilder
impl StructuralPartialEq for ReferenceLineBuilder
Auto Trait Implementations§
impl Freeze for ReferenceLineBuilder
impl RefUnwindSafe for ReferenceLineBuilder
impl Send for ReferenceLineBuilder
impl Sync for ReferenceLineBuilder
impl Unpin for ReferenceLineBuilder
impl UnwindSafe for ReferenceLineBuilder
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);