#[non_exhaustive]pub struct PitPolicyRuleBuilder { /* private fields */ }
Expand description
A builder for PitPolicyRule
.
Implementations§
Source§impl PitPolicyRuleBuilder
impl PitPolicyRuleBuilder
Sourcepub fn set_rule_id(self, input: Option<i64>) -> Self
pub fn set_rule_id(self, input: Option<i64>) -> Self
The ID of the rule.
Sourcepub fn get_rule_id(&self) -> &Option<i64>
pub fn get_rule_id(&self) -> &Option<i64>
The ID of the rule.
Sourcepub fn units(self, input: PitPolicyRuleUnits) -> Self
pub fn units(self, input: PitPolicyRuleUnits) -> Self
The units used to measure the interval and retentionDuration.
This field is required.Sourcepub fn set_units(self, input: Option<PitPolicyRuleUnits>) -> Self
pub fn set_units(self, input: Option<PitPolicyRuleUnits>) -> Self
The units used to measure the interval and retentionDuration.
Sourcepub fn get_units(&self) -> &Option<PitPolicyRuleUnits>
pub fn get_units(&self) -> &Option<PitPolicyRuleUnits>
The units used to measure the interval and retentionDuration.
Sourcepub fn interval(self, input: i32) -> Self
pub fn interval(self, input: i32) -> Self
How often, in the chosen units, a snapshot should be taken.
This field is required.Sourcepub fn set_interval(self, input: Option<i32>) -> Self
pub fn set_interval(self, input: Option<i32>) -> Self
How often, in the chosen units, a snapshot should be taken.
Sourcepub fn get_interval(&self) -> &Option<i32>
pub fn get_interval(&self) -> &Option<i32>
How often, in the chosen units, a snapshot should be taken.
Sourcepub fn retention_duration(self, input: i32) -> Self
pub fn retention_duration(self, input: i32) -> Self
The duration to retain a snapshot for, in the chosen units.
This field is required.Sourcepub fn set_retention_duration(self, input: Option<i32>) -> Self
pub fn set_retention_duration(self, input: Option<i32>) -> Self
The duration to retain a snapshot for, in the chosen units.
Sourcepub fn get_retention_duration(&self) -> &Option<i32>
pub fn get_retention_duration(&self) -> &Option<i32>
The duration to retain a snapshot for, in the chosen units.
Sourcepub fn set_enabled(self, input: Option<bool>) -> Self
pub fn set_enabled(self, input: Option<bool>) -> Self
Whether this rule is enabled or not.
Sourcepub fn get_enabled(&self) -> &Option<bool>
pub fn get_enabled(&self) -> &Option<bool>
Whether this rule is enabled or not.
Sourcepub fn build(self) -> Result<PitPolicyRule, BuildError>
pub fn build(self) -> Result<PitPolicyRule, BuildError>
Consumes the builder and constructs a PitPolicyRule
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for PitPolicyRuleBuilder
impl Clone for PitPolicyRuleBuilder
Source§fn clone(&self) -> PitPolicyRuleBuilder
fn clone(&self) -> PitPolicyRuleBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PitPolicyRuleBuilder
impl Debug for PitPolicyRuleBuilder
Source§impl Default for PitPolicyRuleBuilder
impl Default for PitPolicyRuleBuilder
Source§fn default() -> PitPolicyRuleBuilder
fn default() -> PitPolicyRuleBuilder
Source§impl PartialEq for PitPolicyRuleBuilder
impl PartialEq for PitPolicyRuleBuilder
impl StructuralPartialEq for PitPolicyRuleBuilder
Auto Trait Implementations§
impl Freeze for PitPolicyRuleBuilder
impl RefUnwindSafe for PitPolicyRuleBuilder
impl Send for PitPolicyRuleBuilder
impl Sync for PitPolicyRuleBuilder
impl Unpin for PitPolicyRuleBuilder
impl UnwindSafe for PitPolicyRuleBuilder
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);