#[non_exhaustive]pub struct S3BucketConfigurationBuilder { /* private fields */ }Expand description
A builder for S3BucketConfiguration.
Implementations§
Source§impl S3BucketConfigurationBuilder
impl S3BucketConfigurationBuilder
Sourcepub fn bucket_name(self, input: impl Into<String>) -> Self
pub fn bucket_name(self, input: impl Into<String>) -> Self
The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
This field is required.Sourcepub fn set_bucket_name(self, input: Option<String>) -> Self
pub fn set_bucket_name(self, input: Option<String>) -> Self
The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
Sourcepub fn get_bucket_name(&self) -> &Option<String>
pub fn get_bucket_name(&self) -> &Option<String>
The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
Sourcepub fn bucket_prefix(self, input: impl Into<String>) -> Self
pub fn bucket_prefix(self, input: impl Into<String>) -> Self
The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
This field is required.Sourcepub fn set_bucket_prefix(self, input: Option<String>) -> Self
pub fn set_bucket_prefix(self, input: Option<String>) -> Self
The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
Sourcepub fn get_bucket_prefix(&self) -> &Option<String>
pub fn get_bucket_prefix(&self) -> &Option<String>
The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
Sourcepub fn bucket_region(self, input: impl Into<String>) -> Self
pub fn bucket_region(self, input: impl Into<String>) -> Self
The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
Sourcepub fn set_bucket_region(self, input: Option<String>) -> Self
pub fn set_bucket_region(self, input: Option<String>) -> Self
The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
Sourcepub fn get_bucket_region(&self) -> &Option<String>
pub fn get_bucket_region(&self) -> &Option<String>
The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
Sourcepub fn build(self) -> Result<S3BucketConfiguration, BuildError>
pub fn build(self) -> Result<S3BucketConfiguration, BuildError>
Consumes the builder and constructs a S3BucketConfiguration.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for S3BucketConfigurationBuilder
impl Clone for S3BucketConfigurationBuilder
Source§fn clone(&self) -> S3BucketConfigurationBuilder
fn clone(&self) -> S3BucketConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for S3BucketConfigurationBuilder
impl Debug for S3BucketConfigurationBuilder
Source§impl Default for S3BucketConfigurationBuilder
impl Default for S3BucketConfigurationBuilder
Source§fn default() -> S3BucketConfigurationBuilder
fn default() -> S3BucketConfigurationBuilder
Source§impl PartialEq for S3BucketConfigurationBuilder
impl PartialEq for S3BucketConfigurationBuilder
Source§fn eq(&self, other: &S3BucketConfigurationBuilder) -> bool
fn eq(&self, other: &S3BucketConfigurationBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for S3BucketConfigurationBuilder
Auto Trait Implementations§
impl Freeze for S3BucketConfigurationBuilder
impl RefUnwindSafe for S3BucketConfigurationBuilder
impl Send for S3BucketConfigurationBuilder
impl Sync for S3BucketConfigurationBuilder
impl Unpin for S3BucketConfigurationBuilder
impl UnwindSafe for S3BucketConfigurationBuilder
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);