#[non_exhaustive]pub struct PivotTotalOptionsBuilder { /* private fields */ }Expand description
A builder for PivotTotalOptions.
Implementations§
source§impl PivotTotalOptionsBuilder
impl PivotTotalOptionsBuilder
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
The 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
The 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>
The cell styling options for the total cells.
sourcepub fn value_cell_style(self, input: TableCellStyle) -> Self
pub fn value_cell_style(self, input: TableCellStyle) -> Self
The cell styling options for the totals of value cells.
sourcepub fn set_value_cell_style(self, input: Option<TableCellStyle>) -> Self
pub fn set_value_cell_style(self, input: Option<TableCellStyle>) -> Self
The cell styling options for the totals of value cells.
sourcepub fn get_value_cell_style(&self) -> &Option<TableCellStyle>
pub fn get_value_cell_style(&self) -> &Option<TableCellStyle>
The cell styling options for the totals of value cells.
sourcepub fn metric_header_cell_style(self, input: TableCellStyle) -> Self
pub fn metric_header_cell_style(self, input: TableCellStyle) -> Self
The cell styling options for the total of header cells.
sourcepub fn set_metric_header_cell_style(self, input: Option<TableCellStyle>) -> Self
pub fn set_metric_header_cell_style(self, input: Option<TableCellStyle>) -> Self
The cell styling options for the total of header cells.
sourcepub fn get_metric_header_cell_style(&self) -> &Option<TableCellStyle>
pub fn get_metric_header_cell_style(&self) -> &Option<TableCellStyle>
The cell styling options for the total of header 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 options 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 options 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 options for each value field.
sourcepub fn build(self) -> PivotTotalOptions
pub fn build(self) -> PivotTotalOptions
Consumes the builder and constructs a PivotTotalOptions.
Trait Implementations§
source§impl Clone for PivotTotalOptionsBuilder
impl Clone for PivotTotalOptionsBuilder
source§fn clone(&self) -> PivotTotalOptionsBuilder
fn clone(&self) -> PivotTotalOptionsBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Debug for PivotTotalOptionsBuilder
impl Debug for PivotTotalOptionsBuilder
source§impl Default for PivotTotalOptionsBuilder
impl Default for PivotTotalOptionsBuilder
source§fn default() -> PivotTotalOptionsBuilder
fn default() -> PivotTotalOptionsBuilder
source§impl PartialEq for PivotTotalOptionsBuilder
impl PartialEq for PivotTotalOptionsBuilder
impl StructuralPartialEq for PivotTotalOptionsBuilder
Auto Trait Implementations§
impl Freeze for PivotTotalOptionsBuilder
impl RefUnwindSafe for PivotTotalOptionsBuilder
impl Send for PivotTotalOptionsBuilder
impl Sync for PivotTotalOptionsBuilder
impl Unpin for PivotTotalOptionsBuilder
impl UnwindSafe for PivotTotalOptionsBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit)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);