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