#[non_exhaustive]pub struct RuleSummaryBuilder { /* private fields */ }
Expand description
A builder for RuleSummary
.
Implementations§
Source§impl RuleSummaryBuilder
impl RuleSummaryBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the rule.
This field is required.Sourcepub fn rule_id(self, input: impl Into<String>) -> Self
pub fn rule_id(self, input: impl Into<String>) -> Self
A unique identifier for the rule.
This field is required.Sourcepub fn set_rule_id(self, input: Option<String>) -> Self
pub fn set_rule_id(self, input: Option<String>) -> Self
A unique identifier for the rule.
Sourcepub fn get_rule_id(&self) -> &Option<String>
pub fn get_rule_id(&self) -> &Option<String>
A unique identifier for the rule.
Sourcepub fn rule_arn(self, input: impl Into<String>) -> Self
pub fn rule_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the rule.
This field is required.Sourcepub fn set_rule_arn(self, input: Option<String>) -> Self
pub fn set_rule_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the rule.
Sourcepub fn get_rule_arn(&self) -> &Option<String>
pub fn get_rule_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the rule.
Sourcepub fn event_source_name(self, input: EventSourceName) -> Self
pub fn event_source_name(self, input: EventSourceName) -> Self
The name of the event source.
This field is required.Sourcepub fn set_event_source_name(self, input: Option<EventSourceName>) -> Self
pub fn set_event_source_name(self, input: Option<EventSourceName>) -> Self
The name of the event source.
Sourcepub fn get_event_source_name(&self) -> &Option<EventSourceName>
pub fn get_event_source_name(&self) -> &Option<EventSourceName>
The name of the event source.
Sourcepub fn publish_status(self, input: RulePublishStatus) -> Self
pub fn publish_status(self, input: RulePublishStatus) -> Self
The publish status of the rule.
This field is required.Sourcepub fn set_publish_status(self, input: Option<RulePublishStatus>) -> Self
pub fn set_publish_status(self, input: Option<RulePublishStatus>) -> Self
The publish status of the rule.
Sourcepub fn get_publish_status(&self) -> &Option<RulePublishStatus>
pub fn get_publish_status(&self) -> &Option<RulePublishStatus>
The publish status of the rule.
Sourcepub fn action_summaries(self, input: ActionSummary) -> Self
pub fn action_summaries(self, input: ActionSummary) -> Self
Appends an item to action_summaries
.
To override the contents of this collection use set_action_summaries
.
A list of ActionTypes associated with a rule.
Sourcepub fn set_action_summaries(self, input: Option<Vec<ActionSummary>>) -> Self
pub fn set_action_summaries(self, input: Option<Vec<ActionSummary>>) -> Self
A list of ActionTypes associated with a rule.
Sourcepub fn get_action_summaries(&self) -> &Option<Vec<ActionSummary>>
pub fn get_action_summaries(&self) -> &Option<Vec<ActionSummary>>
A list of ActionTypes associated with a rule.
Sourcepub fn created_time(self, input: DateTime) -> Self
pub fn created_time(self, input: DateTime) -> Self
The timestamp for when the rule was created.
This field is required.Sourcepub fn set_created_time(self, input: Option<DateTime>) -> Self
pub fn set_created_time(self, input: Option<DateTime>) -> Self
The timestamp for when the rule was created.
Sourcepub fn get_created_time(&self) -> &Option<DateTime>
pub fn get_created_time(&self) -> &Option<DateTime>
The timestamp for when the rule was created.
Sourcepub fn last_updated_time(self, input: DateTime) -> Self
pub fn last_updated_time(self, input: DateTime) -> Self
The timestamp for when the rule was last updated.
This field is required.Sourcepub fn set_last_updated_time(self, input: Option<DateTime>) -> Self
pub fn set_last_updated_time(self, input: Option<DateTime>) -> Self
The timestamp for when the rule was last updated.
Sourcepub fn get_last_updated_time(&self) -> &Option<DateTime>
pub fn get_last_updated_time(&self) -> &Option<DateTime>
The timestamp for when the rule was last updated.
Sourcepub fn build(self) -> Result<RuleSummary, BuildError>
pub fn build(self) -> Result<RuleSummary, BuildError>
Consumes the builder and constructs a RuleSummary
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for RuleSummaryBuilder
impl Clone for RuleSummaryBuilder
Source§fn clone(&self) -> RuleSummaryBuilder
fn clone(&self) -> RuleSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RuleSummaryBuilder
impl Debug for RuleSummaryBuilder
Source§impl Default for RuleSummaryBuilder
impl Default for RuleSummaryBuilder
Source§fn default() -> RuleSummaryBuilder
fn default() -> RuleSummaryBuilder
Source§impl PartialEq for RuleSummaryBuilder
impl PartialEq for RuleSummaryBuilder
impl StructuralPartialEq for RuleSummaryBuilder
Auto Trait Implementations§
impl Freeze for RuleSummaryBuilder
impl RefUnwindSafe for RuleSummaryBuilder
impl Send for RuleSummaryBuilder
impl Sync for RuleSummaryBuilder
impl Unpin for RuleSummaryBuilder
impl UnwindSafe for RuleSummaryBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);