#[non_exhaustive]pub struct ContainerHealthCheckBuilder { /* private fields */ }
Expand description
A builder for ContainerHealthCheck
.
Implementations§
Source§impl ContainerHealthCheckBuilder
impl ContainerHealthCheckBuilder
Sourcepub fn command(self, input: impl Into<String>) -> Self
pub fn command(self, input: impl Into<String>) -> Self
Appends an item to command
.
To override the contents of this collection use set_command
.
A string array that specifies the command that the container runs to determine if it's healthy.
Sourcepub fn set_command(self, input: Option<Vec<String>>) -> Self
pub fn set_command(self, input: Option<Vec<String>>) -> Self
A string array that specifies the command that the container runs to determine if it's healthy.
Sourcepub fn get_command(&self) -> &Option<Vec<String>>
pub fn get_command(&self) -> &Option<Vec<String>>
A string array that specifies the command that the container runs to determine if it's healthy.
Sourcepub fn interval(self, input: i32) -> Self
pub fn interval(self, input: i32) -> Self
The time period (in seconds) between each health check.
Sourcepub fn set_interval(self, input: Option<i32>) -> Self
pub fn set_interval(self, input: Option<i32>) -> Self
The time period (in seconds) between each health check.
Sourcepub fn get_interval(&self) -> &Option<i32>
pub fn get_interval(&self) -> &Option<i32>
The time period (in seconds) between each health check.
Sourcepub fn retries(self, input: i32) -> Self
pub fn retries(self, input: i32) -> Self
The number of times to retry a failed health check before flagging the container unhealthy. The first run of the command does not count as a retry.
Sourcepub fn set_retries(self, input: Option<i32>) -> Self
pub fn set_retries(self, input: Option<i32>) -> Self
The number of times to retry a failed health check before flagging the container unhealthy. The first run of the command does not count as a retry.
Sourcepub fn get_retries(&self) -> &Option<i32>
pub fn get_retries(&self) -> &Option<i32>
The number of times to retry a failed health check before flagging the container unhealthy. The first run of the command does not count as a retry.
Sourcepub fn start_period(self, input: i32) -> Self
pub fn start_period(self, input: i32) -> Self
The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.
Sourcepub fn set_start_period(self, input: Option<i32>) -> Self
pub fn set_start_period(self, input: Option<i32>) -> Self
The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.
Sourcepub fn get_start_period(&self) -> &Option<i32>
pub fn get_start_period(&self) -> &Option<i32>
The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.
Sourcepub fn timeout(self, input: i32) -> Self
pub fn timeout(self, input: i32) -> Self
The time period (in seconds) to wait for a health check to succeed before counting a failed health check.
Sourcepub fn set_timeout(self, input: Option<i32>) -> Self
pub fn set_timeout(self, input: Option<i32>) -> Self
The time period (in seconds) to wait for a health check to succeed before counting a failed health check.
Sourcepub fn get_timeout(&self) -> &Option<i32>
pub fn get_timeout(&self) -> &Option<i32>
The time period (in seconds) to wait for a health check to succeed before counting a failed health check.
Sourcepub fn build(self) -> ContainerHealthCheck
pub fn build(self) -> ContainerHealthCheck
Consumes the builder and constructs a ContainerHealthCheck
.
Trait Implementations§
Source§impl Clone for ContainerHealthCheckBuilder
impl Clone for ContainerHealthCheckBuilder
Source§fn clone(&self) -> ContainerHealthCheckBuilder
fn clone(&self) -> ContainerHealthCheckBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ContainerHealthCheckBuilder
impl Debug for ContainerHealthCheckBuilder
Source§impl Default for ContainerHealthCheckBuilder
impl Default for ContainerHealthCheckBuilder
Source§fn default() -> ContainerHealthCheckBuilder
fn default() -> ContainerHealthCheckBuilder
impl StructuralPartialEq for ContainerHealthCheckBuilder
Auto Trait Implementations§
impl Freeze for ContainerHealthCheckBuilder
impl RefUnwindSafe for ContainerHealthCheckBuilder
impl Send for ContainerHealthCheckBuilder
impl Sync for ContainerHealthCheckBuilder
impl Unpin for ContainerHealthCheckBuilder
impl UnwindSafe for ContainerHealthCheckBuilder
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);