#[non_exhaustive]pub struct TotalOptionsBuilder { /* private fields */ }
Expand description
A builder for TotalOptions
.
Implementations§
Source§impl TotalOptionsBuilder
impl TotalOptionsBuilder
Sourcepub fn totals_visibility(self, input: Visibility) -> Self
pub fn totals_visibility(self, input: Visibility) -> Self
The visibility configuration for the total cells.
Sourcepub fn set_totals_visibility(self, input: Option<Visibility>) -> Self
pub fn set_totals_visibility(self, input: Option<Visibility>) -> Self
The visibility configuration for the total cells.
Sourcepub fn get_totals_visibility(&self) -> &Option<Visibility>
pub fn get_totals_visibility(&self) -> &Option<Visibility>
The visibility configuration for the total cells.
Sourcepub fn placement(self, input: TableTotalsPlacement) -> Self
pub fn placement(self, input: TableTotalsPlacement) -> Self
The placement (start, end) for the total cells.
Sourcepub fn set_placement(self, input: Option<TableTotalsPlacement>) -> Self
pub fn set_placement(self, input: Option<TableTotalsPlacement>) -> Self
The placement (start, end) for the total cells.
Sourcepub fn get_placement(&self) -> &Option<TableTotalsPlacement>
pub fn get_placement(&self) -> &Option<TableTotalsPlacement>
The placement (start, end) for the total cells.
Sourcepub fn scroll_status(self, input: TableTotalsScrollStatus) -> Self
pub fn scroll_status(self, input: TableTotalsScrollStatus) -> Self
The scroll status (pinned, scrolled) for the total cells.
Sourcepub fn set_scroll_status(self, input: Option<TableTotalsScrollStatus>) -> Self
pub fn set_scroll_status(self, input: Option<TableTotalsScrollStatus>) -> Self
The scroll status (pinned, scrolled) for the total cells.
Sourcepub fn get_scroll_status(&self) -> &Option<TableTotalsScrollStatus>
pub fn get_scroll_status(&self) -> &Option<TableTotalsScrollStatus>
The scroll status (pinned, scrolled) for the total cells.
Sourcepub fn custom_label(self, input: impl Into<String>) -> Self
pub fn custom_label(self, input: impl Into<String>) -> Self
The custom label string for the total cells.
Sourcepub fn set_custom_label(self, input: Option<String>) -> Self
pub fn set_custom_label(self, input: Option<String>) -> Self
The custom label string for the total cells.
Sourcepub fn get_custom_label(&self) -> &Option<String>
pub fn get_custom_label(&self) -> &Option<String>
The custom label string for the total cells.
Sourcepub fn total_cell_style(self, input: TableCellStyle) -> Self
pub fn total_cell_style(self, input: TableCellStyle) -> Self
Cell styling options for the total cells.
Sourcepub fn set_total_cell_style(self, input: Option<TableCellStyle>) -> Self
pub fn set_total_cell_style(self, input: Option<TableCellStyle>) -> Self
Cell styling options for the total cells.
Sourcepub fn get_total_cell_style(&self) -> &Option<TableCellStyle>
pub fn get_total_cell_style(&self) -> &Option<TableCellStyle>
Cell styling options for the total cells.
Sourcepub fn total_aggregation_options(self, input: TotalAggregationOption) -> Self
pub fn total_aggregation_options(self, input: TotalAggregationOption) -> Self
Appends an item to total_aggregation_options
.
To override the contents of this collection use set_total_aggregation_options
.
The total aggregation settings for each value field.
Sourcepub fn set_total_aggregation_options(
self,
input: Option<Vec<TotalAggregationOption>>,
) -> Self
pub fn set_total_aggregation_options( self, input: Option<Vec<TotalAggregationOption>>, ) -> Self
The total aggregation settings for each value field.
Sourcepub fn get_total_aggregation_options(
&self,
) -> &Option<Vec<TotalAggregationOption>>
pub fn get_total_aggregation_options( &self, ) -> &Option<Vec<TotalAggregationOption>>
The total aggregation settings for each value field.
Sourcepub fn build(self) -> TotalOptions
pub fn build(self) -> TotalOptions
Consumes the builder and constructs a TotalOptions
.
Trait Implementations§
Source§impl Clone for TotalOptionsBuilder
impl Clone for TotalOptionsBuilder
Source§fn clone(&self) -> TotalOptionsBuilder
fn clone(&self) -> TotalOptionsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TotalOptionsBuilder
impl Debug for TotalOptionsBuilder
Source§impl Default for TotalOptionsBuilder
impl Default for TotalOptionsBuilder
Source§fn default() -> TotalOptionsBuilder
fn default() -> TotalOptionsBuilder
Source§impl PartialEq for TotalOptionsBuilder
impl PartialEq for TotalOptionsBuilder
impl StructuralPartialEq for TotalOptionsBuilder
Auto Trait Implementations§
impl Freeze for TotalOptionsBuilder
impl RefUnwindSafe for TotalOptionsBuilder
impl Send for TotalOptionsBuilder
impl Sync for TotalOptionsBuilder
impl Unpin for TotalOptionsBuilder
impl UnwindSafe for TotalOptionsBuilder
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);