#[non_exhaustive]pub struct BatchStatementRequestBuilder { /* private fields */ }
Expand description
A builder for BatchStatementRequest
.
Implementations§
source§impl BatchStatementRequestBuilder
impl BatchStatementRequestBuilder
sourcepub fn statement(self, input: impl Into<String>) -> Self
pub fn statement(self, input: impl Into<String>) -> Self
A valid PartiQL statement.
This field is required.sourcepub fn set_statement(self, input: Option<String>) -> Self
pub fn set_statement(self, input: Option<String>) -> Self
A valid PartiQL statement.
sourcepub fn get_statement(&self) -> &Option<String>
pub fn get_statement(&self) -> &Option<String>
A valid PartiQL statement.
sourcepub fn parameters(self, input: AttributeValue) -> Self
pub fn parameters(self, input: AttributeValue) -> Self
Appends an item to parameters
.
To override the contents of this collection use set_parameters
.
The parameters associated with a PartiQL statement in the batch request.
sourcepub fn set_parameters(self, input: Option<Vec<AttributeValue>>) -> Self
pub fn set_parameters(self, input: Option<Vec<AttributeValue>>) -> Self
The parameters associated with a PartiQL statement in the batch request.
sourcepub fn get_parameters(&self) -> &Option<Vec<AttributeValue>>
pub fn get_parameters(&self) -> &Option<Vec<AttributeValue>>
The parameters associated with a PartiQL statement in the batch request.
sourcepub fn consistent_read(self, input: bool) -> Self
pub fn consistent_read(self, input: bool) -> Self
The read consistency of the PartiQL batch request.
sourcepub fn set_consistent_read(self, input: Option<bool>) -> Self
pub fn set_consistent_read(self, input: Option<bool>) -> Self
The read consistency of the PartiQL batch request.
sourcepub fn get_consistent_read(&self) -> &Option<bool>
pub fn get_consistent_read(&self) -> &Option<bool>
The read consistency of the PartiQL batch request.
sourcepub fn return_values_on_condition_check_failure(
self,
input: ReturnValuesOnConditionCheckFailure,
) -> Self
pub fn return_values_on_condition_check_failure( self, input: ReturnValuesOnConditionCheckFailure, ) -> Self
An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
sourcepub fn set_return_values_on_condition_check_failure(
self,
input: Option<ReturnValuesOnConditionCheckFailure>,
) -> Self
pub fn set_return_values_on_condition_check_failure( self, input: Option<ReturnValuesOnConditionCheckFailure>, ) -> Self
An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
sourcepub fn get_return_values_on_condition_check_failure(
&self,
) -> &Option<ReturnValuesOnConditionCheckFailure>
pub fn get_return_values_on_condition_check_failure( &self, ) -> &Option<ReturnValuesOnConditionCheckFailure>
An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
sourcepub fn build(self) -> Result<BatchStatementRequest, BuildError>
pub fn build(self) -> Result<BatchStatementRequest, BuildError>
Consumes the builder and constructs a BatchStatementRequest
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for BatchStatementRequestBuilder
impl Clone for BatchStatementRequestBuilder
source§fn clone(&self) -> BatchStatementRequestBuilder
fn clone(&self) -> BatchStatementRequestBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for BatchStatementRequestBuilder
impl Debug for BatchStatementRequestBuilder
source§impl Default for BatchStatementRequestBuilder
impl Default for BatchStatementRequestBuilder
source§fn default() -> BatchStatementRequestBuilder
fn default() -> BatchStatementRequestBuilder
source§impl PartialEq for BatchStatementRequestBuilder
impl PartialEq for BatchStatementRequestBuilder
source§fn eq(&self, other: &BatchStatementRequestBuilder) -> bool
fn eq(&self, other: &BatchStatementRequestBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for BatchStatementRequestBuilder
Auto Trait Implementations§
impl Freeze for BatchStatementRequestBuilder
impl RefUnwindSafe for BatchStatementRequestBuilder
impl Send for BatchStatementRequestBuilder
impl Sync for BatchStatementRequestBuilder
impl Unpin for BatchStatementRequestBuilder
impl UnwindSafe for BatchStatementRequestBuilder
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§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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 more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();
§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.§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);