#[non_exhaustive]pub struct PluginVisualFieldWellBuilder { /* private fields */ }
Expand description
A builder for PluginVisualFieldWell
.
Implementations§
Source§impl PluginVisualFieldWellBuilder
impl PluginVisualFieldWellBuilder
Sourcepub fn axis_name(self, input: PluginVisualAxisName) -> Self
pub fn axis_name(self, input: PluginVisualAxisName) -> Self
The semantic axis name for the field well.
Sourcepub fn set_axis_name(self, input: Option<PluginVisualAxisName>) -> Self
pub fn set_axis_name(self, input: Option<PluginVisualAxisName>) -> Self
The semantic axis name for the field well.
Sourcepub fn get_axis_name(&self) -> &Option<PluginVisualAxisName>
pub fn get_axis_name(&self) -> &Option<PluginVisualAxisName>
The semantic axis name for the field well.
Sourcepub fn dimensions(self, input: DimensionField) -> Self
pub fn dimensions(self, input: DimensionField) -> Self
Appends an item to dimensions
.
To override the contents of this collection use set_dimensions
.
A list of dimensions for the field well.
Sourcepub fn set_dimensions(self, input: Option<Vec<DimensionField>>) -> Self
pub fn set_dimensions(self, input: Option<Vec<DimensionField>>) -> Self
A list of dimensions for the field well.
Sourcepub fn get_dimensions(&self) -> &Option<Vec<DimensionField>>
pub fn get_dimensions(&self) -> &Option<Vec<DimensionField>>
A list of dimensions for the field well.
Sourcepub fn measures(self, input: MeasureField) -> Self
pub fn measures(self, input: MeasureField) -> Self
Appends an item to measures
.
To override the contents of this collection use set_measures
.
A list of measures that exist in the field well.
Sourcepub fn set_measures(self, input: Option<Vec<MeasureField>>) -> Self
pub fn set_measures(self, input: Option<Vec<MeasureField>>) -> Self
A list of measures that exist in the field well.
Sourcepub fn get_measures(&self) -> &Option<Vec<MeasureField>>
pub fn get_measures(&self) -> &Option<Vec<MeasureField>>
A list of measures that exist in the field well.
Sourcepub fn unaggregated(self, input: UnaggregatedField) -> Self
pub fn unaggregated(self, input: UnaggregatedField) -> Self
Appends an item to unaggregated
.
To override the contents of this collection use set_unaggregated
.
A list of unaggregated fields that exist in the field well.
Sourcepub fn set_unaggregated(self, input: Option<Vec<UnaggregatedField>>) -> Self
pub fn set_unaggregated(self, input: Option<Vec<UnaggregatedField>>) -> Self
A list of unaggregated fields that exist in the field well.
Sourcepub fn get_unaggregated(&self) -> &Option<Vec<UnaggregatedField>>
pub fn get_unaggregated(&self) -> &Option<Vec<UnaggregatedField>>
A list of unaggregated fields that exist in the field well.
Sourcepub fn build(self) -> PluginVisualFieldWell
pub fn build(self) -> PluginVisualFieldWell
Consumes the builder and constructs a PluginVisualFieldWell
.
Trait Implementations§
Source§impl Clone for PluginVisualFieldWellBuilder
impl Clone for PluginVisualFieldWellBuilder
Source§fn clone(&self) -> PluginVisualFieldWellBuilder
fn clone(&self) -> PluginVisualFieldWellBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PluginVisualFieldWellBuilder
impl Debug for PluginVisualFieldWellBuilder
Source§impl Default for PluginVisualFieldWellBuilder
impl Default for PluginVisualFieldWellBuilder
Source§fn default() -> PluginVisualFieldWellBuilder
fn default() -> PluginVisualFieldWellBuilder
Source§impl PartialEq for PluginVisualFieldWellBuilder
impl PartialEq for PluginVisualFieldWellBuilder
Source§fn eq(&self, other: &PluginVisualFieldWellBuilder) -> bool
fn eq(&self, other: &PluginVisualFieldWellBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for PluginVisualFieldWellBuilder
Auto Trait Implementations§
impl Freeze for PluginVisualFieldWellBuilder
impl RefUnwindSafe for PluginVisualFieldWellBuilder
impl Send for PluginVisualFieldWellBuilder
impl Sync for PluginVisualFieldWellBuilder
impl Unpin for PluginVisualFieldWellBuilder
impl UnwindSafe for PluginVisualFieldWellBuilder
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);