#[non_exhaustive]pub struct QueryOutputBuilder { /* private fields */ }
Expand description
A builder for QueryOutput
.
Implementations§
Source§impl QueryOutputBuilder
impl QueryOutputBuilder
Sourcepub fn query_id(self, input: impl Into<String>) -> Self
pub fn query_id(self, input: impl Into<String>) -> Self
A unique ID for the given query.
This field is required.Sourcepub fn set_query_id(self, input: Option<String>) -> Self
pub fn set_query_id(self, input: Option<String>) -> Self
A unique ID for the given query.
Sourcepub fn get_query_id(&self) -> &Option<String>
pub fn get_query_id(&self) -> &Option<String>
A unique ID for the given query.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
A pagination token that can be used again on a Query
call to get the next set of results.
Sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
A pagination token that can be used again on a Query
call to get the next set of results.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
A pagination token that can be used again on a Query
call to get the next set of results.
Sourcepub fn rows(self, input: Row) -> Self
pub fn rows(self, input: Row) -> Self
Appends an item to rows
.
To override the contents of this collection use set_rows
.
The result set rows returned by the query.
Sourcepub fn set_rows(self, input: Option<Vec<Row>>) -> Self
pub fn set_rows(self, input: Option<Vec<Row>>) -> Self
The result set rows returned by the query.
Sourcepub fn column_info(self, input: ColumnInfo) -> Self
pub fn column_info(self, input: ColumnInfo) -> Self
Appends an item to column_info
.
To override the contents of this collection use set_column_info
.
The column data types of the returned result set.
Sourcepub fn set_column_info(self, input: Option<Vec<ColumnInfo>>) -> Self
pub fn set_column_info(self, input: Option<Vec<ColumnInfo>>) -> Self
The column data types of the returned result set.
Sourcepub fn get_column_info(&self) -> &Option<Vec<ColumnInfo>>
pub fn get_column_info(&self) -> &Option<Vec<ColumnInfo>>
The column data types of the returned result set.
Sourcepub fn query_status(self, input: QueryStatus) -> Self
pub fn query_status(self, input: QueryStatus) -> Self
Information about the status of the query, including progress and bytes scanned.
Sourcepub fn set_query_status(self, input: Option<QueryStatus>) -> Self
pub fn set_query_status(self, input: Option<QueryStatus>) -> Self
Information about the status of the query, including progress and bytes scanned.
Sourcepub fn get_query_status(&self) -> &Option<QueryStatus>
pub fn get_query_status(&self) -> &Option<QueryStatus>
Information about the status of the query, including progress and bytes scanned.
Sourcepub fn query_insights_response(self, input: QueryInsightsResponse) -> Self
pub fn query_insights_response(self, input: QueryInsightsResponse) -> Self
Encapsulates QueryInsights
containing insights and metrics related to the query that you executed.
Sourcepub fn set_query_insights_response(
self,
input: Option<QueryInsightsResponse>,
) -> Self
pub fn set_query_insights_response( self, input: Option<QueryInsightsResponse>, ) -> Self
Encapsulates QueryInsights
containing insights and metrics related to the query that you executed.
Sourcepub fn get_query_insights_response(&self) -> &Option<QueryInsightsResponse>
pub fn get_query_insights_response(&self) -> &Option<QueryInsightsResponse>
Encapsulates QueryInsights
containing insights and metrics related to the query that you executed.
Sourcepub fn build(self) -> Result<QueryOutput, BuildError>
pub fn build(self) -> Result<QueryOutput, BuildError>
Consumes the builder and constructs a QueryOutput
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for QueryOutputBuilder
impl Clone for QueryOutputBuilder
Source§fn clone(&self) -> QueryOutputBuilder
fn clone(&self) -> QueryOutputBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for QueryOutputBuilder
impl Debug for QueryOutputBuilder
Source§impl Default for QueryOutputBuilder
impl Default for QueryOutputBuilder
Source§fn default() -> QueryOutputBuilder
fn default() -> QueryOutputBuilder
Source§impl PartialEq for QueryOutputBuilder
impl PartialEq for QueryOutputBuilder
impl StructuralPartialEq for QueryOutputBuilder
Auto Trait Implementations§
impl Freeze for QueryOutputBuilder
impl RefUnwindSafe for QueryOutputBuilder
impl Send for QueryOutputBuilder
impl Sync for QueryOutputBuilder
impl Unpin for QueryOutputBuilder
impl UnwindSafe for QueryOutputBuilder
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);