#[non_exhaustive]pub struct TopicCalculatedField {Show 17 fields
pub calculated_field_name: String,
pub calculated_field_description: Option<String>,
pub expression: String,
pub calculated_field_synonyms: Option<Vec<String>>,
pub is_included_in_topic: bool,
pub disable_indexing: Option<bool>,
pub column_data_role: Option<ColumnDataRole>,
pub time_granularity: Option<TopicTimeGranularity>,
pub default_formatting: Option<DefaultFormatting>,
pub aggregation: Option<DefaultAggregation>,
pub comparative_order: Option<ComparativeOrder>,
pub semantic_type: Option<SemanticType>,
pub allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>,
pub not_allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>,
pub never_aggregate_in_filter: bool,
pub cell_value_synonyms: Option<Vec<CellValueSynonym>>,
pub non_additive: Option<bool>,
}Expand description
A structure that represents a calculated field.
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.calculated_field_name: StringThe calculated field name.
calculated_field_description: Option<String>The calculated field description.
expression: StringThe calculated field expression.
calculated_field_synonyms: Option<Vec<String>>The other names or aliases for the calculated field.
is_included_in_topic: boolA boolean value that indicates if a calculated field is included in the topic.
disable_indexing: Option<bool>A Boolean value that indicates if a calculated field is visible in the autocomplete.
column_data_role: Option<ColumnDataRole>The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
time_granularity: Option<TopicTimeGranularity>The level of time precision that is used to aggregate DateTime values.
default_formatting: Option<DefaultFormatting>The default formatting definition.
aggregation: Option<DefaultAggregation>The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
comparative_order: Option<ComparativeOrder>The order in which data is displayed for the calculated field when it's used in a comparative context.
semantic_type: Option<SemanticType>The semantic type.
allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
not_allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
never_aggregate_in_filter: boolA Boolean value that indicates whether to never aggregate calculated field in filters.
cell_value_synonyms: Option<Vec<CellValueSynonym>>The other names or aliases for the calculated field cell value.
non_additive: Option<bool>The non additive for the table style target.
Implementations§
Source§impl TopicCalculatedField
impl TopicCalculatedField
Sourcepub fn calculated_field_name(&self) -> &str
pub fn calculated_field_name(&self) -> &str
The calculated field name.
Sourcepub fn calculated_field_description(&self) -> Option<&str>
pub fn calculated_field_description(&self) -> Option<&str>
The calculated field description.
Sourcepub fn expression(&self) -> &str
pub fn expression(&self) -> &str
The calculated field expression.
Sourcepub fn calculated_field_synonyms(&self) -> &[String]
pub fn calculated_field_synonyms(&self) -> &[String]
The other names or aliases for the calculated field.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .calculated_field_synonyms.is_none().
Sourcepub fn is_included_in_topic(&self) -> bool
pub fn is_included_in_topic(&self) -> bool
A boolean value that indicates if a calculated field is included in the topic.
Sourcepub fn disable_indexing(&self) -> Option<bool>
pub fn disable_indexing(&self) -> Option<bool>
A Boolean value that indicates if a calculated field is visible in the autocomplete.
Sourcepub fn column_data_role(&self) -> Option<&ColumnDataRole>
pub fn column_data_role(&self) -> Option<&ColumnDataRole>
The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
Sourcepub fn time_granularity(&self) -> Option<&TopicTimeGranularity>
pub fn time_granularity(&self) -> Option<&TopicTimeGranularity>
The level of time precision that is used to aggregate DateTime values.
Sourcepub fn default_formatting(&self) -> Option<&DefaultFormatting>
pub fn default_formatting(&self) -> Option<&DefaultFormatting>
The default formatting definition.
Sourcepub fn aggregation(&self) -> Option<&DefaultAggregation>
pub fn aggregation(&self) -> Option<&DefaultAggregation>
The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
Sourcepub fn comparative_order(&self) -> Option<&ComparativeOrder>
pub fn comparative_order(&self) -> Option<&ComparativeOrder>
The order in which data is displayed for the calculated field when it's used in a comparative context.
Sourcepub fn semantic_type(&self) -> Option<&SemanticType>
pub fn semantic_type(&self) -> Option<&SemanticType>
The semantic type.
Sourcepub fn allowed_aggregations(&self) -> &[AuthorSpecifiedAggregation]
pub fn allowed_aggregations(&self) -> &[AuthorSpecifiedAggregation]
The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .allowed_aggregations.is_none().
Sourcepub fn not_allowed_aggregations(&self) -> &[AuthorSpecifiedAggregation]
pub fn not_allowed_aggregations(&self) -> &[AuthorSpecifiedAggregation]
The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .not_allowed_aggregations.is_none().
Sourcepub fn never_aggregate_in_filter(&self) -> bool
pub fn never_aggregate_in_filter(&self) -> bool
A Boolean value that indicates whether to never aggregate calculated field in filters.
Sourcepub fn cell_value_synonyms(&self) -> &[CellValueSynonym]
pub fn cell_value_synonyms(&self) -> &[CellValueSynonym]
The other names or aliases for the calculated field cell value.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cell_value_synonyms.is_none().
Sourcepub fn non_additive(&self) -> Option<bool>
pub fn non_additive(&self) -> Option<bool>
The non additive for the table style target.
Source§impl TopicCalculatedField
impl TopicCalculatedField
Sourcepub fn builder() -> TopicCalculatedFieldBuilder
pub fn builder() -> TopicCalculatedFieldBuilder
Creates a new builder-style object to manufacture TopicCalculatedField.
Trait Implementations§
Source§impl Clone for TopicCalculatedField
impl Clone for TopicCalculatedField
Source§fn clone(&self) -> TopicCalculatedField
fn clone(&self) -> TopicCalculatedField
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for TopicCalculatedField
impl Debug for TopicCalculatedField
Source§impl PartialEq for TopicCalculatedField
impl PartialEq for TopicCalculatedField
impl StructuralPartialEq for TopicCalculatedField
Auto Trait Implementations§
impl Freeze for TopicCalculatedField
impl RefUnwindSafe for TopicCalculatedField
impl Send for TopicCalculatedField
impl Sync for TopicCalculatedField
impl Unpin for TopicCalculatedField
impl UnwindSafe for TopicCalculatedField
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);