#[non_exhaustive]pub struct TopicIrBuilder { /* private fields */ }
Expand description
A builder for TopicIr
.
Implementations§
Source§impl TopicIrBuilder
impl TopicIrBuilder
Sourcepub fn metrics(self, input: TopicIrMetric) -> Self
pub fn metrics(self, input: TopicIrMetric) -> Self
Appends an item to metrics
.
To override the contents of this collection use set_metrics
.
The metrics for the TopicIR
.
Sourcepub fn set_metrics(self, input: Option<Vec<TopicIrMetric>>) -> Self
pub fn set_metrics(self, input: Option<Vec<TopicIrMetric>>) -> Self
The metrics for the TopicIR
.
Sourcepub fn get_metrics(&self) -> &Option<Vec<TopicIrMetric>>
pub fn get_metrics(&self) -> &Option<Vec<TopicIrMetric>>
The metrics for the TopicIR
.
Sourcepub fn group_by_list(self, input: TopicIrGroupBy) -> Self
pub fn group_by_list(self, input: TopicIrGroupBy) -> Self
Appends an item to group_by_list
.
To override the contents of this collection use set_group_by_list
.
The GroupBy list for the TopicIR
.
Sourcepub fn set_group_by_list(self, input: Option<Vec<TopicIrGroupBy>>) -> Self
pub fn set_group_by_list(self, input: Option<Vec<TopicIrGroupBy>>) -> Self
The GroupBy list for the TopicIR
.
Sourcepub fn get_group_by_list(&self) -> &Option<Vec<TopicIrGroupBy>>
pub fn get_group_by_list(&self) -> &Option<Vec<TopicIrGroupBy>>
The GroupBy list for the TopicIR
.
Sourcepub fn filters(self, input: Vec<TopicIrFilterOption>) -> Self
pub fn filters(self, input: Vec<TopicIrFilterOption>) -> Self
Appends an item to filters
.
To override the contents of this collection use set_filters
.
The filters for the TopicIR
.
Sourcepub fn set_filters(self, input: Option<Vec<Vec<TopicIrFilterOption>>>) -> Self
pub fn set_filters(self, input: Option<Vec<Vec<TopicIrFilterOption>>>) -> Self
The filters for the TopicIR
.
Sourcepub fn get_filters(&self) -> &Option<Vec<Vec<TopicIrFilterOption>>>
pub fn get_filters(&self) -> &Option<Vec<Vec<TopicIrFilterOption>>>
The filters for the TopicIR
.
Sourcepub fn sort(self, input: TopicSortClause) -> Self
pub fn sort(self, input: TopicSortClause) -> Self
The sort for the TopicIR
.
Sourcepub fn set_sort(self, input: Option<TopicSortClause>) -> Self
pub fn set_sort(self, input: Option<TopicSortClause>) -> Self
The sort for the TopicIR
.
Sourcepub fn get_sort(&self) -> &Option<TopicSortClause>
pub fn get_sort(&self) -> &Option<TopicSortClause>
The sort for the TopicIR
.
Sourcepub fn contribution_analysis(self, input: TopicIrContributionAnalysis) -> Self
pub fn contribution_analysis(self, input: TopicIrContributionAnalysis) -> Self
The contribution analysis for the TopicIR
.
Sourcepub fn set_contribution_analysis(
self,
input: Option<TopicIrContributionAnalysis>,
) -> Self
pub fn set_contribution_analysis( self, input: Option<TopicIrContributionAnalysis>, ) -> Self
The contribution analysis for the TopicIR
.
Sourcepub fn get_contribution_analysis(&self) -> &Option<TopicIrContributionAnalysis>
pub fn get_contribution_analysis(&self) -> &Option<TopicIrContributionAnalysis>
The contribution analysis for the TopicIR
.
Sourcepub fn visual(self, input: VisualOptions) -> Self
pub fn visual(self, input: VisualOptions) -> Self
The visual for the TopicIR
.
Sourcepub fn set_visual(self, input: Option<VisualOptions>) -> Self
pub fn set_visual(self, input: Option<VisualOptions>) -> Self
The visual for the TopicIR
.
Sourcepub fn get_visual(&self) -> &Option<VisualOptions>
pub fn get_visual(&self) -> &Option<VisualOptions>
The visual for the TopicIR
.
Trait Implementations§
Source§impl Clone for TopicIrBuilder
impl Clone for TopicIrBuilder
Source§fn clone(&self) -> TopicIrBuilder
fn clone(&self) -> TopicIrBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TopicIrBuilder
impl Debug for TopicIrBuilder
Source§impl Default for TopicIrBuilder
impl Default for TopicIrBuilder
Source§fn default() -> TopicIrBuilder
fn default() -> TopicIrBuilder
Source§impl PartialEq for TopicIrBuilder
impl PartialEq for TopicIrBuilder
impl StructuralPartialEq for TopicIrBuilder
Auto Trait Implementations§
impl Freeze for TopicIrBuilder
impl RefUnwindSafe for TopicIrBuilder
impl Send for TopicIrBuilder
impl Sync for TopicIrBuilder
impl Unpin for TopicIrBuilder
impl UnwindSafe for TopicIrBuilder
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);