#[non_exhaustive]pub struct CanaryRunConfigOutputBuilder { /* private fields */ }
Expand description
A builder for CanaryRunConfigOutput
.
Implementations§
Source§impl CanaryRunConfigOutputBuilder
impl CanaryRunConfigOutputBuilder
Sourcepub fn timeout_in_seconds(self, input: i32) -> Self
pub fn timeout_in_seconds(self, input: i32) -> Self
How long the canary is allowed to run before it must stop.
Sourcepub fn set_timeout_in_seconds(self, input: Option<i32>) -> Self
pub fn set_timeout_in_seconds(self, input: Option<i32>) -> Self
How long the canary is allowed to run before it must stop.
Sourcepub fn get_timeout_in_seconds(&self) -> &Option<i32>
pub fn get_timeout_in_seconds(&self) -> &Option<i32>
How long the canary is allowed to run before it must stop.
Sourcepub fn memory_in_mb(self, input: i32) -> Self
pub fn memory_in_mb(self, input: i32) -> Self
The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
Sourcepub fn set_memory_in_mb(self, input: Option<i32>) -> Self
pub fn set_memory_in_mb(self, input: Option<i32>) -> Self
The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
Sourcepub fn get_memory_in_mb(&self) -> &Option<i32>
pub fn get_memory_in_mb(&self) -> &Option<i32>
The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
Sourcepub fn active_tracing(self, input: bool) -> Self
pub fn active_tracing(self, input: bool) -> Self
Displays whether this canary run used active X-Ray tracing.
Sourcepub fn set_active_tracing(self, input: Option<bool>) -> Self
pub fn set_active_tracing(self, input: Option<bool>) -> Self
Displays whether this canary run used active X-Ray tracing.
Sourcepub fn get_active_tracing(&self) -> &Option<bool>
pub fn get_active_tracing(&self) -> &Option<bool>
Displays whether this canary run used active X-Ray tracing.
Sourcepub fn ephemeral_storage(self, input: i32) -> Self
pub fn ephemeral_storage(self, input: i32) -> Self
Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.
Sourcepub fn set_ephemeral_storage(self, input: Option<i32>) -> Self
pub fn set_ephemeral_storage(self, input: Option<i32>) -> Self
Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.
Sourcepub fn get_ephemeral_storage(&self) -> &Option<i32>
pub fn get_ephemeral_storage(&self) -> &Option<i32>
Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.
Sourcepub fn build(self) -> CanaryRunConfigOutput
pub fn build(self) -> CanaryRunConfigOutput
Consumes the builder and constructs a CanaryRunConfigOutput
.
Trait Implementations§
Source§impl Clone for CanaryRunConfigOutputBuilder
impl Clone for CanaryRunConfigOutputBuilder
Source§fn clone(&self) -> CanaryRunConfigOutputBuilder
fn clone(&self) -> CanaryRunConfigOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CanaryRunConfigOutputBuilder
impl Debug for CanaryRunConfigOutputBuilder
Source§impl Default for CanaryRunConfigOutputBuilder
impl Default for CanaryRunConfigOutputBuilder
Source§fn default() -> CanaryRunConfigOutputBuilder
fn default() -> CanaryRunConfigOutputBuilder
Source§impl PartialEq for CanaryRunConfigOutputBuilder
impl PartialEq for CanaryRunConfigOutputBuilder
Source§fn eq(&self, other: &CanaryRunConfigOutputBuilder) -> bool
fn eq(&self, other: &CanaryRunConfigOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CanaryRunConfigOutputBuilder
Auto Trait Implementations§
impl Freeze for CanaryRunConfigOutputBuilder
impl RefUnwindSafe for CanaryRunConfigOutputBuilder
impl Send for CanaryRunConfigOutputBuilder
impl Sync for CanaryRunConfigOutputBuilder
impl Unpin for CanaryRunConfigOutputBuilder
impl UnwindSafe for CanaryRunConfigOutputBuilder
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);