#[non_exhaustive]pub struct TopicColumnBuilder { /* private fields */ }
Expand description
A builder for TopicColumn
.
Implementations§
Source§impl TopicColumnBuilder
impl TopicColumnBuilder
Sourcepub fn column_name(self, input: impl Into<String>) -> Self
pub fn column_name(self, input: impl Into<String>) -> Self
The name of the column.
This field is required.Sourcepub fn set_column_name(self, input: Option<String>) -> Self
pub fn set_column_name(self, input: Option<String>) -> Self
The name of the column.
Sourcepub fn get_column_name(&self) -> &Option<String>
pub fn get_column_name(&self) -> &Option<String>
The name of the column.
Sourcepub fn column_friendly_name(self, input: impl Into<String>) -> Self
pub fn column_friendly_name(self, input: impl Into<String>) -> Self
A user-friendly name for the column.
Sourcepub fn set_column_friendly_name(self, input: Option<String>) -> Self
pub fn set_column_friendly_name(self, input: Option<String>) -> Self
A user-friendly name for the column.
Sourcepub fn get_column_friendly_name(&self) -> &Option<String>
pub fn get_column_friendly_name(&self) -> &Option<String>
A user-friendly name for the column.
Sourcepub fn column_description(self, input: impl Into<String>) -> Self
pub fn column_description(self, input: impl Into<String>) -> Self
A description of the column and its contents.
Sourcepub fn set_column_description(self, input: Option<String>) -> Self
pub fn set_column_description(self, input: Option<String>) -> Self
A description of the column and its contents.
Sourcepub fn get_column_description(&self) -> &Option<String>
pub fn get_column_description(&self) -> &Option<String>
A description of the column and its contents.
Sourcepub fn column_synonyms(self, input: impl Into<String>) -> Self
pub fn column_synonyms(self, input: impl Into<String>) -> Self
Appends an item to column_synonyms
.
To override the contents of this collection use set_column_synonyms
.
The other names or aliases for the column.
Sourcepub fn set_column_synonyms(self, input: Option<Vec<String>>) -> Self
pub fn set_column_synonyms(self, input: Option<Vec<String>>) -> Self
The other names or aliases for the column.
Sourcepub fn get_column_synonyms(&self) -> &Option<Vec<String>>
pub fn get_column_synonyms(&self) -> &Option<Vec<String>>
The other names or aliases for the column.
Sourcepub fn column_data_role(self, input: ColumnDataRole) -> Self
pub fn column_data_role(self, input: ColumnDataRole) -> Self
The role of the column in the data. Valid values are DIMENSION
and MEASURE
.
Sourcepub fn set_column_data_role(self, input: Option<ColumnDataRole>) -> Self
pub fn set_column_data_role(self, input: Option<ColumnDataRole>) -> Self
The role of the column in the data. Valid values are DIMENSION
and MEASURE
.
Sourcepub fn get_column_data_role(&self) -> &Option<ColumnDataRole>
pub fn get_column_data_role(&self) -> &Option<ColumnDataRole>
The role of the column in the data. Valid values are DIMENSION
and MEASURE
.
Sourcepub fn aggregation(self, input: DefaultAggregation) -> Self
pub fn aggregation(self, input: DefaultAggregation) -> Self
The type of aggregation that is performed on the column data when it's queried.
Sourcepub fn set_aggregation(self, input: Option<DefaultAggregation>) -> Self
pub fn set_aggregation(self, input: Option<DefaultAggregation>) -> Self
The type of aggregation that is performed on the column data when it's queried.
Sourcepub fn get_aggregation(&self) -> &Option<DefaultAggregation>
pub fn get_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, input: bool) -> Self
pub fn is_included_in_topic(self, input: bool) -> Self
A Boolean value that indicates whether the column is included in the query results.
Sourcepub fn set_is_included_in_topic(self, input: Option<bool>) -> Self
pub fn set_is_included_in_topic(self, input: Option<bool>) -> Self
A Boolean value that indicates whether the column is included in the query results.
Sourcepub fn get_is_included_in_topic(&self) -> &Option<bool>
pub fn get_is_included_in_topic(&self) -> &Option<bool>
A Boolean value that indicates whether the column is included in the query results.
Sourcepub fn disable_indexing(self, input: bool) -> Self
pub fn disable_indexing(self, input: bool) -> Self
A Boolean value that indicates whether the column shows in the autocomplete functionality.
Sourcepub fn set_disable_indexing(self, input: Option<bool>) -> Self
pub fn set_disable_indexing(self, input: Option<bool>) -> Self
A Boolean value that indicates whether the column shows in the autocomplete functionality.
Sourcepub fn get_disable_indexing(&self) -> &Option<bool>
pub fn get_disable_indexing(&self) -> &Option<bool>
A Boolean value that indicates whether the column shows in the autocomplete functionality.
Sourcepub fn comparative_order(self, input: ComparativeOrder) -> Self
pub fn comparative_order(self, input: ComparativeOrder) -> Self
The order in which data is displayed for the column when it's used in a comparative context.
Sourcepub fn set_comparative_order(self, input: Option<ComparativeOrder>) -> Self
pub fn set_comparative_order(self, input: Option<ComparativeOrder>) -> Self
The order in which data is displayed for the column when it's used in a comparative context.
Sourcepub fn get_comparative_order(&self) -> &Option<ComparativeOrder>
pub fn get_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, input: SemanticType) -> Self
pub fn semantic_type(self, input: SemanticType) -> Self
The semantic type of data contained in the column.
Sourcepub fn set_semantic_type(self, input: Option<SemanticType>) -> Self
pub fn set_semantic_type(self, input: Option<SemanticType>) -> Self
The semantic type of data contained in the column.
Sourcepub fn get_semantic_type(&self) -> &Option<SemanticType>
pub fn get_semantic_type(&self) -> &Option<SemanticType>
The semantic type of data contained in the column.
Sourcepub fn time_granularity(self, input: TopicTimeGranularity) -> Self
pub fn time_granularity(self, input: TopicTimeGranularity) -> Self
The level of time precision that is used to aggregate DateTime
values.
Sourcepub fn set_time_granularity(self, input: Option<TopicTimeGranularity>) -> Self
pub fn set_time_granularity(self, input: Option<TopicTimeGranularity>) -> Self
The level of time precision that is used to aggregate DateTime
values.
Sourcepub fn get_time_granularity(&self) -> &Option<TopicTimeGranularity>
pub fn get_time_granularity(&self) -> &Option<TopicTimeGranularity>
The level of time precision that is used to aggregate DateTime
values.
Sourcepub fn allowed_aggregations(self, input: AuthorSpecifiedAggregation) -> Self
pub fn allowed_aggregations(self, input: AuthorSpecifiedAggregation) -> Self
Appends an item to allowed_aggregations
.
To override the contents of this collection use set_allowed_aggregations
.
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
.
Sourcepub fn set_allowed_aggregations(
self,
input: Option<Vec<AuthorSpecifiedAggregation>>,
) -> Self
pub fn set_allowed_aggregations( self, input: Option<Vec<AuthorSpecifiedAggregation>>, ) -> Self
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
.
Sourcepub fn get_allowed_aggregations(
&self,
) -> &Option<Vec<AuthorSpecifiedAggregation>>
pub fn get_allowed_aggregations( &self, ) -> &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
.
Sourcepub fn not_allowed_aggregations(self, input: AuthorSpecifiedAggregation) -> Self
pub fn not_allowed_aggregations(self, input: AuthorSpecifiedAggregation) -> Self
Appends an item to not_allowed_aggregations
.
To override the contents of this collection use set_not_allowed_aggregations
.
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
.
Sourcepub fn set_not_allowed_aggregations(
self,
input: Option<Vec<AuthorSpecifiedAggregation>>,
) -> Self
pub fn set_not_allowed_aggregations( self, input: Option<Vec<AuthorSpecifiedAggregation>>, ) -> Self
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
.
Sourcepub fn get_not_allowed_aggregations(
&self,
) -> &Option<Vec<AuthorSpecifiedAggregation>>
pub fn get_not_allowed_aggregations( &self, ) -> &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
.
Sourcepub fn default_formatting(self, input: DefaultFormatting) -> Self
pub fn default_formatting(self, input: DefaultFormatting) -> Self
The default formatting used for values in the column.
Sourcepub fn set_default_formatting(self, input: Option<DefaultFormatting>) -> Self
pub fn set_default_formatting(self, input: Option<DefaultFormatting>) -> Self
The default formatting used for values in the column.
Sourcepub fn get_default_formatting(&self) -> &Option<DefaultFormatting>
pub fn get_default_formatting(&self) -> &Option<DefaultFormatting>
The default formatting used for values in the column.
Sourcepub fn never_aggregate_in_filter(self, input: bool) -> Self
pub fn never_aggregate_in_filter(self, input: bool) -> Self
A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
Sourcepub fn set_never_aggregate_in_filter(self, input: Option<bool>) -> Self
pub fn set_never_aggregate_in_filter(self, input: Option<bool>) -> Self
A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
Sourcepub fn get_never_aggregate_in_filter(&self) -> &Option<bool>
pub fn get_never_aggregate_in_filter(&self) -> &Option<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, input: CellValueSynonym) -> Self
pub fn cell_value_synonyms(self, input: CellValueSynonym) -> Self
Appends an item to cell_value_synonyms
.
To override the contents of this collection use set_cell_value_synonyms
.
The other names or aliases for the column cell value.
Sourcepub fn set_cell_value_synonyms(
self,
input: Option<Vec<CellValueSynonym>>,
) -> Self
pub fn set_cell_value_synonyms( self, input: Option<Vec<CellValueSynonym>>, ) -> Self
The other names or aliases for the column cell value.
Sourcepub fn get_cell_value_synonyms(&self) -> &Option<Vec<CellValueSynonym>>
pub fn get_cell_value_synonyms(&self) -> &Option<Vec<CellValueSynonym>>
The other names or aliases for the column cell value.
Sourcepub fn non_additive(self, input: bool) -> Self
pub fn non_additive(self, input: bool) -> Self
The non additive value for the column.
Sourcepub fn set_non_additive(self, input: Option<bool>) -> Self
pub fn set_non_additive(self, input: Option<bool>) -> Self
The non additive value for the column.
Sourcepub fn get_non_additive(&self) -> &Option<bool>
pub fn get_non_additive(&self) -> &Option<bool>
The non additive value for the column.
Sourcepub fn build(self) -> Result<TopicColumn, BuildError>
pub fn build(self) -> Result<TopicColumn, BuildError>
Consumes the builder and constructs a TopicColumn
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for TopicColumnBuilder
impl Clone for TopicColumnBuilder
Source§fn clone(&self) -> TopicColumnBuilder
fn clone(&self) -> TopicColumnBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TopicColumnBuilder
impl Debug for TopicColumnBuilder
Source§impl Default for TopicColumnBuilder
impl Default for TopicColumnBuilder
Source§fn default() -> TopicColumnBuilder
fn default() -> TopicColumnBuilder
Source§impl PartialEq for TopicColumnBuilder
impl PartialEq for TopicColumnBuilder
impl StructuralPartialEq for TopicColumnBuilder
Auto Trait Implementations§
impl Freeze for TopicColumnBuilder
impl RefUnwindSafe for TopicColumnBuilder
impl Send for TopicColumnBuilder
impl Sync for TopicColumnBuilder
impl Unpin for TopicColumnBuilder
impl UnwindSafe for TopicColumnBuilder
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);