#[non_exhaustive]pub struct QueryGenerationTableBuilder { /* private fields */ }
Expand description
A builder for QueryGenerationTable
.
Implementations§
Source§impl QueryGenerationTableBuilder
impl QueryGenerationTableBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the table for which the other fields in this object apply.
This field is required.Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the table for which the other fields in this object apply.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the table for which the other fields in this object apply.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the table that helps the query engine understand the contents of the table.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the table that helps the query engine understand the contents of the table.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the table that helps the query engine understand the contents of the table.
Sourcepub fn inclusion(self, input: IncludeExclude) -> Self
pub fn inclusion(self, input: IncludeExclude) -> Self
Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE
, the table will be ignored. If you specify INCLUDE
, all other tables will be ignored.
Sourcepub fn set_inclusion(self, input: Option<IncludeExclude>) -> Self
pub fn set_inclusion(self, input: Option<IncludeExclude>) -> Self
Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE
, the table will be ignored. If you specify INCLUDE
, all other tables will be ignored.
Sourcepub fn get_inclusion(&self) -> &Option<IncludeExclude>
pub fn get_inclusion(&self) -> &Option<IncludeExclude>
Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE
, the table will be ignored. If you specify INCLUDE
, all other tables will be ignored.
Sourcepub fn columns(self, input: QueryGenerationColumn) -> Self
pub fn columns(self, input: QueryGenerationColumn) -> Self
Appends an item to columns
.
To override the contents of this collection use set_columns
.
An array of objects, each of which defines information about a column in the table.
Sourcepub fn set_columns(self, input: Option<Vec<QueryGenerationColumn>>) -> Self
pub fn set_columns(self, input: Option<Vec<QueryGenerationColumn>>) -> Self
An array of objects, each of which defines information about a column in the table.
Sourcepub fn get_columns(&self) -> &Option<Vec<QueryGenerationColumn>>
pub fn get_columns(&self) -> &Option<Vec<QueryGenerationColumn>>
An array of objects, each of which defines information about a column in the table.
Sourcepub fn build(self) -> Result<QueryGenerationTable, BuildError>
pub fn build(self) -> Result<QueryGenerationTable, BuildError>
Consumes the builder and constructs a QueryGenerationTable
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for QueryGenerationTableBuilder
impl Clone for QueryGenerationTableBuilder
Source§fn clone(&self) -> QueryGenerationTableBuilder
fn clone(&self) -> QueryGenerationTableBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for QueryGenerationTableBuilder
impl Debug for QueryGenerationTableBuilder
Source§impl Default for QueryGenerationTableBuilder
impl Default for QueryGenerationTableBuilder
Source§fn default() -> QueryGenerationTableBuilder
fn default() -> QueryGenerationTableBuilder
impl StructuralPartialEq for QueryGenerationTableBuilder
Auto Trait Implementations§
impl Freeze for QueryGenerationTableBuilder
impl RefUnwindSafe for QueryGenerationTableBuilder
impl Send for QueryGenerationTableBuilder
impl Sync for QueryGenerationTableBuilder
impl Unpin for QueryGenerationTableBuilder
impl UnwindSafe for QueryGenerationTableBuilder
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);