#[non_exhaustive]pub struct TopBottomMoversComputation {
pub computation_id: String,
pub name: Option<String>,
pub time: Option<DimensionField>,
pub category: Option<DimensionField>,
pub value: Option<MeasureField>,
pub mover_size: Option<i32>,
pub sort_order: Option<TopBottomSortOrder>,
pub type: TopBottomComputationType,
}
Expand description
The top movers and bottom movers computation setup.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.computation_id: String
The ID for a computation.
name: Option<String>
The name of a computation.
time: Option<DimensionField>
The time field that is used in a computation.
category: Option<DimensionField>
The category field that is used in a computation.
value: Option<MeasureField>
The value field that is used in a computation.
mover_size: Option<i32>
The mover size setup of the top and bottom movers computation.
sort_order: Option<TopBottomSortOrder>
The sort order setup of the top and bottom movers computation.
type: TopBottomComputationType
The computation type. Choose from the following options:
-
TOP: Top movers computation.
-
BOTTOM: Bottom movers computation.
Implementations§
Source§impl TopBottomMoversComputation
impl TopBottomMoversComputation
Sourcepub fn computation_id(&self) -> &str
pub fn computation_id(&self) -> &str
The ID for a computation.
Sourcepub fn time(&self) -> Option<&DimensionField>
pub fn time(&self) -> Option<&DimensionField>
The time field that is used in a computation.
Sourcepub fn category(&self) -> Option<&DimensionField>
pub fn category(&self) -> Option<&DimensionField>
The category field that is used in a computation.
Sourcepub fn value(&self) -> Option<&MeasureField>
pub fn value(&self) -> Option<&MeasureField>
The value field that is used in a computation.
Sourcepub fn mover_size(&self) -> Option<i32>
pub fn mover_size(&self) -> Option<i32>
The mover size setup of the top and bottom movers computation.
Sourcepub fn sort_order(&self) -> Option<&TopBottomSortOrder>
pub fn sort_order(&self) -> Option<&TopBottomSortOrder>
The sort order setup of the top and bottom movers computation.
Sourcepub fn type(&self) -> &TopBottomComputationType
pub fn type(&self) -> &TopBottomComputationType
The computation type. Choose from the following options:
-
TOP: Top movers computation.
-
BOTTOM: Bottom movers computation.
Source§impl TopBottomMoversComputation
impl TopBottomMoversComputation
Sourcepub fn builder() -> TopBottomMoversComputationBuilder
pub fn builder() -> TopBottomMoversComputationBuilder
Creates a new builder-style object to manufacture TopBottomMoversComputation
.
Trait Implementations§
Source§impl Clone for TopBottomMoversComputation
impl Clone for TopBottomMoversComputation
Source§fn clone(&self) -> TopBottomMoversComputation
fn clone(&self) -> TopBottomMoversComputation
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TopBottomMoversComputation
impl Debug for TopBottomMoversComputation
impl StructuralPartialEq for TopBottomMoversComputation
Auto Trait Implementations§
impl Freeze for TopBottomMoversComputation
impl RefUnwindSafe for TopBottomMoversComputation
impl Send for TopBottomMoversComputation
impl Sync for TopBottomMoversComputation
impl Unpin for TopBottomMoversComputation
impl UnwindSafe for TopBottomMoversComputation
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);