Struct TopicColumnBuilder

Source
#[non_exhaustive]
pub struct TopicColumnBuilder { /* private fields */ }
Expand description

A builder for TopicColumn.

Implementations§

Source§

impl TopicColumnBuilder

Source

pub fn column_name(self, input: impl Into<String>) -> Self

The name of the column.

This field is required.
Source

pub fn set_column_name(self, input: Option<String>) -> Self

The name of the column.

Source

pub fn get_column_name(&self) -> &Option<String>

The name of the column.

Source

pub fn column_friendly_name(self, input: impl Into<String>) -> Self

A user-friendly name for the column.

Source

pub fn set_column_friendly_name(self, input: Option<String>) -> Self

A user-friendly name for the column.

Source

pub fn get_column_friendly_name(&self) -> &Option<String>

A user-friendly name for the column.

Source

pub fn column_description(self, input: impl Into<String>) -> Self

A description of the column and its contents.

Source

pub fn set_column_description(self, input: Option<String>) -> Self

A description of the column and its contents.

Source

pub fn get_column_description(&self) -> &Option<String>

A description of the column and its contents.

Source

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.

Source

pub fn set_column_synonyms(self, input: Option<Vec<String>>) -> Self

The other names or aliases for the column.

Source

pub fn get_column_synonyms(&self) -> &Option<Vec<String>>

The other names or aliases for the column.

Source

pub fn column_data_role(self, input: ColumnDataRole) -> Self

The role of the column in the data. Valid values are DIMENSION and MEASURE.

Source

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.

Source

pub fn get_column_data_role(&self) -> &Option<ColumnDataRole>

The role of the column in the data. Valid values are DIMENSION and MEASURE.

Source

pub fn aggregation(self, input: DefaultAggregation) -> Self

The type of aggregation that is performed on the column data when it's queried.

Source

pub fn set_aggregation(self, input: Option<DefaultAggregation>) -> Self

The type of aggregation that is performed on the column data when it's queried.

Source

pub fn get_aggregation(&self) -> &Option<DefaultAggregation>

The type of aggregation that is performed on the column data when it's queried.

Source

pub fn is_included_in_topic(self, input: bool) -> Self

A Boolean value that indicates whether the column is included in the query results.

Source

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.

Source

pub fn get_is_included_in_topic(&self) -> &Option<bool>

A Boolean value that indicates whether the column is included in the query results.

Source

pub fn disable_indexing(self, input: bool) -> Self

A Boolean value that indicates whether the column shows in the autocomplete functionality.

Source

pub fn set_disable_indexing(self, input: Option<bool>) -> Self

A Boolean value that indicates whether the column shows in the autocomplete functionality.

Source

pub fn get_disable_indexing(&self) -> &Option<bool>

A Boolean value that indicates whether the column shows in the autocomplete functionality.

Source

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.

Source

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.

Source

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.

Source

pub fn semantic_type(self, input: SemanticType) -> Self

The semantic type of data contained in the column.

Source

pub fn set_semantic_type(self, input: Option<SemanticType>) -> Self

The semantic type of data contained in the column.

Source

pub fn get_semantic_type(&self) -> &Option<SemanticType>

The semantic type of data contained in the column.

Source

pub fn time_granularity(self, input: TopicTimeGranularity) -> Self

The level of time precision that is used to aggregate DateTime values.

Source

pub fn set_time_granularity(self, input: Option<TopicTimeGranularity>) -> Self

The level of time precision that is used to aggregate DateTime values.

Source

pub fn get_time_granularity(&self) -> &Option<TopicTimeGranularity>

The level of time precision that is used to aggregate DateTime values.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn default_formatting(self, input: DefaultFormatting) -> Self

The default formatting used for values in the column.

Source

pub fn set_default_formatting(self, input: Option<DefaultFormatting>) -> Self

The default formatting used for values in the column.

Source

pub fn get_default_formatting(&self) -> &Option<DefaultFormatting>

The default formatting used for values in the column.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn set_cell_value_synonyms( self, input: Option<Vec<CellValueSynonym>>, ) -> Self

The other names or aliases for the column cell value.

Source

pub fn get_cell_value_synonyms(&self) -> &Option<Vec<CellValueSynonym>>

The other names or aliases for the column cell value.

Source

pub fn non_additive(self, input: bool) -> Self

The non additive value for the column.

Source

pub fn set_non_additive(self, input: Option<bool>) -> Self

The non additive value for the column.

Source

pub fn get_non_additive(&self) -> &Option<bool>

The non additive value for the column.

Source

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

Source§

fn clone(&self) -> TopicColumnBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TopicColumnBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for TopicColumnBuilder

Source§

fn default() -> TopicColumnBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for TopicColumnBuilder

Source§

fn eq(&self, other: &TopicColumnBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TopicColumnBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,