#[non_exhaustive]pub struct GetStatementResultOutputBuilder { /* private fields */ }
Expand description
A builder for GetStatementResultOutput
.
Implementations§
Source§impl GetStatementResultOutputBuilder
impl GetStatementResultOutputBuilder
Sourcepub fn records(self, input: Vec<Field>) -> Self
pub fn records(self, input: Vec<Field>) -> Self
Appends an item to records
.
To override the contents of this collection use set_records
.
The results of the SQL statement in JSON format.
Sourcepub fn set_records(self, input: Option<Vec<Vec<Field>>>) -> Self
pub fn set_records(self, input: Option<Vec<Vec<Field>>>) -> Self
The results of the SQL statement in JSON format.
Sourcepub fn get_records(&self) -> &Option<Vec<Vec<Field>>>
pub fn get_records(&self) -> &Option<Vec<Vec<Field>>>
The results of the SQL statement in JSON format.
Sourcepub fn column_metadata(self, input: ColumnMetadata) -> Self
pub fn column_metadata(self, input: ColumnMetadata) -> Self
Appends an item to column_metadata
.
To override the contents of this collection use set_column_metadata
.
The properties (metadata) of a column.
Sourcepub fn set_column_metadata(self, input: Option<Vec<ColumnMetadata>>) -> Self
pub fn set_column_metadata(self, input: Option<Vec<ColumnMetadata>>) -> Self
The properties (metadata) of a column.
Sourcepub fn get_column_metadata(&self) -> &Option<Vec<ColumnMetadata>>
pub fn get_column_metadata(&self) -> &Option<Vec<ColumnMetadata>>
The properties (metadata) of a column.
Sourcepub fn total_num_rows(self, input: i64) -> Self
pub fn total_num_rows(self, input: i64) -> Self
The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult
operation needed to page through the results.
Sourcepub fn set_total_num_rows(self, input: Option<i64>) -> Self
pub fn set_total_num_rows(self, input: Option<i64>) -> Self
The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult
operation needed to page through the results.
Sourcepub fn get_total_num_rows(&self) -> &Option<i64>
pub fn get_total_num_rows(&self) -> &Option<i64>
The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult
operation needed to page through the results.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
Sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
Sourcepub fn build(self) -> Result<GetStatementResultOutput, BuildError>
pub fn build(self) -> Result<GetStatementResultOutput, BuildError>
Consumes the builder and constructs a GetStatementResultOutput
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for GetStatementResultOutputBuilder
impl Clone for GetStatementResultOutputBuilder
Source§fn clone(&self) -> GetStatementResultOutputBuilder
fn clone(&self) -> GetStatementResultOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for GetStatementResultOutputBuilder
impl Default for GetStatementResultOutputBuilder
Source§fn default() -> GetStatementResultOutputBuilder
fn default() -> GetStatementResultOutputBuilder
Source§impl PartialEq for GetStatementResultOutputBuilder
impl PartialEq for GetStatementResultOutputBuilder
Source§fn eq(&self, other: &GetStatementResultOutputBuilder) -> bool
fn eq(&self, other: &GetStatementResultOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for GetStatementResultOutputBuilder
Auto Trait Implementations§
impl Freeze for GetStatementResultOutputBuilder
impl RefUnwindSafe for GetStatementResultOutputBuilder
impl Send for GetStatementResultOutputBuilder
impl Sync for GetStatementResultOutputBuilder
impl Unpin for GetStatementResultOutputBuilder
impl UnwindSafe for GetStatementResultOutputBuilder
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);