pub struct ParamsBuilder { /* private fields */ }
Expand description
Builder for Params
Implementations§
Source§impl ParamsBuilder
impl ParamsBuilder
Sourcepub fn region(self, value: impl Into<String>) -> Self
pub fn region(self, value: impl Into<String>) -> Self
Sets the value for region
The AWS region used to dispatch the request.
Sourcepub fn set_region(self, param: Option<String>) -> Self
pub fn set_region(self, param: Option<String>) -> Self
Sets the value for region
The AWS region used to dispatch the request.
Sourcepub fn use_fips(self, value: impl Into<bool>) -> Self
pub fn use_fips(self, value: impl Into<bool>) -> Self
Sets the value for use_fips
When unset, this parameter has a default value of false
.
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
Sourcepub fn set_use_fips(self, param: Option<bool>) -> Self
pub fn set_use_fips(self, param: Option<bool>) -> Self
Sets the value for use_fips
When unset, this parameter has a default value of false
.
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
Sourcepub fn use_dual_stack(self, value: impl Into<bool>) -> Self
pub fn use_dual_stack(self, value: impl Into<bool>) -> Self
Sets the value for use_dual_stack
When unset, this parameter has a default value of false
.
When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
Sourcepub fn set_use_dual_stack(self, param: Option<bool>) -> Self
pub fn set_use_dual_stack(self, param: Option<bool>) -> Self
Sets the value for use_dual_stack
When unset, this parameter has a default value of false
.
When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
Sourcepub fn endpoint(self, value: impl Into<String>) -> Self
pub fn endpoint(self, value: impl Into<String>) -> Self
Sets the value for endpoint
Override the endpoint used to send this request
Sourcepub fn set_endpoint(self, param: Option<String>) -> Self
pub fn set_endpoint(self, param: Option<String>) -> Self
Sets the value for endpoint
Override the endpoint used to send this request
Sourcepub fn account_id(self, value: impl Into<String>) -> Self
pub fn account_id(self, value: impl Into<String>) -> Self
Sets the value for account_id
The Account ID used to send the request. This is an optional parameter that will be set automatically for operations that require it.
Sourcepub fn set_account_id(self, param: Option<String>) -> Self
pub fn set_account_id(self, param: Option<String>) -> Self
Sets the value for account_id
The Account ID used to send the request. This is an optional parameter that will be set automatically for operations that require it.
Sourcepub fn requires_account_id(self, value: impl Into<bool>) -> Self
pub fn requires_account_id(self, value: impl Into<bool>) -> Self
Sets the value for requires_account_id
Internal parameter for operations that require account id host prefix.
Sourcepub fn set_requires_account_id(self, param: Option<bool>) -> Self
pub fn set_requires_account_id(self, param: Option<bool>) -> Self
Sets the value for requires_account_id
Internal parameter for operations that require account id host prefix.
Sourcepub fn outpost_id(self, value: impl Into<String>) -> Self
pub fn outpost_id(self, value: impl Into<String>) -> Self
Sets the value for outpost_id
The Outpost ID. Some operations have an optional OutpostId which should be used in endpoint construction.
Sourcepub fn set_outpost_id(self, param: Option<String>) -> Self
pub fn set_outpost_id(self, param: Option<String>) -> Self
Sets the value for outpost_id
The Outpost ID. Some operations have an optional OutpostId which should be used in endpoint construction.
Sourcepub fn bucket(self, value: impl Into<String>) -> Self
pub fn bucket(self, value: impl Into<String>) -> Self
Sets the value for bucket
The S3 bucket used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 bucket.
Sourcepub fn set_bucket(self, param: Option<String>) -> Self
pub fn set_bucket(self, param: Option<String>) -> Self
Sets the value for bucket
The S3 bucket used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 bucket.
Sourcepub fn access_point_name(self, value: impl Into<String>) -> Self
pub fn access_point_name(self, value: impl Into<String>) -> Self
Sets the value for access_point_name
The S3 AccessPointName used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 AccessPoint.
Sourcepub fn set_access_point_name(self, param: Option<String>) -> Self
pub fn set_access_point_name(self, param: Option<String>) -> Self
Sets the value for access_point_name
The S3 AccessPointName used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 AccessPoint.
Sourcepub fn use_arn_region(self, value: impl Into<bool>) -> Self
pub fn use_arn_region(self, value: impl Into<bool>) -> Self
Sets the value for use_arn_region
When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN’s region when constructing the endpoint instead of the client’s configured region.
Sourcepub fn set_use_arn_region(self, param: Option<bool>) -> Self
pub fn set_use_arn_region(self, param: Option<bool>) -> Self
Sets the value for use_arn_region
When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN’s region when constructing the endpoint instead of the client’s configured region.
Sourcepub fn resource_arn(self, value: impl Into<String>) -> Self
pub fn resource_arn(self, value: impl Into<String>) -> Self
Sets the value for resource_arn
The resource ARN included in the request. Only set on TagResource, UntagResourceand ListTagsForResource
Sourcepub fn set_resource_arn(self, param: Option<String>) -> Self
pub fn set_resource_arn(self, param: Option<String>) -> Self
Sets the value for resource_arn
The resource ARN included in the request. Only set on TagResource, UntagResourceand ListTagsForResource
Sourcepub fn use_s3_express_control_endpoint(self, value: impl Into<bool>) -> Self
pub fn use_s3_express_control_endpoint(self, value: impl Into<bool>) -> Self
Sets the value for use_s3_express_control_endpoint
Internal parameter to indicate whether S3Express operation should use control plane, (ex. ListDirectoryAccessPoints)
Sourcepub fn set_use_s3_express_control_endpoint(self, param: Option<bool>) -> Self
pub fn set_use_s3_express_control_endpoint(self, param: Option<bool>) -> Self
Sets the value for use_s3_express_control_endpoint
Internal parameter to indicate whether S3Express operation should use control plane, (ex. ListDirectoryAccessPoints)
Trait Implementations§
Source§impl Clone for ParamsBuilder
impl Clone for ParamsBuilder
Source§fn clone(&self) -> ParamsBuilder
fn clone(&self) -> ParamsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ParamsBuilder
impl Debug for ParamsBuilder
Source§impl Default for ParamsBuilder
impl Default for ParamsBuilder
Source§fn default() -> ParamsBuilder
fn default() -> ParamsBuilder
Source§impl PartialEq for ParamsBuilder
impl PartialEq for ParamsBuilder
impl StructuralPartialEq for ParamsBuilder
Auto Trait Implementations§
impl Freeze for ParamsBuilder
impl RefUnwindSafe for ParamsBuilder
impl Send for ParamsBuilder
impl Sync for ParamsBuilder
impl Unpin for ParamsBuilder
impl UnwindSafe for ParamsBuilder
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);