#[non_exhaustive]pub struct BundleTaskBuilder { /* private fields */ }
Expand description
A builder for BundleTask
.
Implementations§
Source§impl BundleTaskBuilder
impl BundleTaskBuilder
Sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
The ID of the instance associated with this bundle task.
Sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
The ID of the instance associated with this bundle task.
Sourcepub fn get_instance_id(&self) -> &Option<String>
pub fn get_instance_id(&self) -> &Option<String>
The ID of the instance associated with this bundle task.
Sourcepub fn set_bundle_id(self, input: Option<String>) -> Self
pub fn set_bundle_id(self, input: Option<String>) -> Self
The ID of the bundle task.
Sourcepub fn get_bundle_id(&self) -> &Option<String>
pub fn get_bundle_id(&self) -> &Option<String>
The ID of the bundle task.
Sourcepub fn state(self, input: BundleTaskState) -> Self
pub fn state(self, input: BundleTaskState) -> Self
The state of the task.
Sourcepub fn set_state(self, input: Option<BundleTaskState>) -> Self
pub fn set_state(self, input: Option<BundleTaskState>) -> Self
The state of the task.
Sourcepub fn get_state(&self) -> &Option<BundleTaskState>
pub fn get_state(&self) -> &Option<BundleTaskState>
The state of the task.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The time this task started.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The time this task started.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The time this task started.
Sourcepub fn update_time(self, input: DateTime) -> Self
pub fn update_time(self, input: DateTime) -> Self
The time of the most recent update for the task.
Sourcepub fn set_update_time(self, input: Option<DateTime>) -> Self
pub fn set_update_time(self, input: Option<DateTime>) -> Self
The time of the most recent update for the task.
Sourcepub fn get_update_time(&self) -> &Option<DateTime>
pub fn get_update_time(&self) -> &Option<DateTime>
The time of the most recent update for the task.
Sourcepub fn set_storage(self, input: Option<Storage>) -> Self
pub fn set_storage(self, input: Option<Storage>) -> Self
The Amazon S3 storage locations.
Sourcepub fn get_storage(&self) -> &Option<Storage>
pub fn get_storage(&self) -> &Option<Storage>
The Amazon S3 storage locations.
Sourcepub fn progress(self, input: impl Into<String>) -> Self
pub fn progress(self, input: impl Into<String>) -> Self
The level of task completion, as a percent (for example, 20%).
Sourcepub fn set_progress(self, input: Option<String>) -> Self
pub fn set_progress(self, input: Option<String>) -> Self
The level of task completion, as a percent (for example, 20%).
Sourcepub fn get_progress(&self) -> &Option<String>
pub fn get_progress(&self) -> &Option<String>
The level of task completion, as a percent (for example, 20%).
Sourcepub fn bundle_task_error(self, input: BundleTaskError) -> Self
pub fn bundle_task_error(self, input: BundleTaskError) -> Self
If the task fails, a description of the error.
Sourcepub fn set_bundle_task_error(self, input: Option<BundleTaskError>) -> Self
pub fn set_bundle_task_error(self, input: Option<BundleTaskError>) -> Self
If the task fails, a description of the error.
Sourcepub fn get_bundle_task_error(&self) -> &Option<BundleTaskError>
pub fn get_bundle_task_error(&self) -> &Option<BundleTaskError>
If the task fails, a description of the error.
Sourcepub fn build(self) -> BundleTask
pub fn build(self) -> BundleTask
Consumes the builder and constructs a BundleTask
.
Trait Implementations§
Source§impl Clone for BundleTaskBuilder
impl Clone for BundleTaskBuilder
Source§fn clone(&self) -> BundleTaskBuilder
fn clone(&self) -> BundleTaskBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for BundleTaskBuilder
impl Debug for BundleTaskBuilder
Source§impl Default for BundleTaskBuilder
impl Default for BundleTaskBuilder
Source§fn default() -> BundleTaskBuilder
fn default() -> BundleTaskBuilder
Source§impl PartialEq for BundleTaskBuilder
impl PartialEq for BundleTaskBuilder
impl StructuralPartialEq for BundleTaskBuilder
Auto Trait Implementations§
impl Freeze for BundleTaskBuilder
impl RefUnwindSafe for BundleTaskBuilder
impl Send for BundleTaskBuilder
impl Sync for BundleTaskBuilder
impl Unpin for BundleTaskBuilder
impl UnwindSafe for BundleTaskBuilder
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);