#[non_exhaustive]pub struct EventDestinationBuilder { /* private fields */ }
Expand description
A builder for EventDestination
.
Implementations§
Source§impl EventDestinationBuilder
impl EventDestinationBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the event destination. The name must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
-
Contain 64 characters or fewer.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the event destination. The name must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
-
Contain 64 characters or fewer.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the event destination. The name must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
-
Contain 64 characters or fewer.
Sourcepub fn enabled(self, input: bool) -> Self
pub fn enabled(self, input: bool) -> Self
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true
to enable publishing to this destination; set to false
to prevent publishing to this destination. The default value is false
.
Sourcepub fn set_enabled(self, input: Option<bool>) -> Self
pub fn set_enabled(self, input: Option<bool>) -> Self
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true
to enable publishing to this destination; set to false
to prevent publishing to this destination. The default value is false
.
Sourcepub fn get_enabled(&self) -> &Option<bool>
pub fn get_enabled(&self) -> &Option<bool>
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true
to enable publishing to this destination; set to false
to prevent publishing to this destination. The default value is false
.
Sourcepub fn matching_event_types(self, input: EventType) -> Self
pub fn matching_event_types(self, input: EventType) -> Self
Appends an item to matching_event_types
.
To override the contents of this collection use set_matching_event_types
.
The type of email sending events to publish to the event destination.
-
send
- The call was successful and Amazon SES is attempting to deliver the email. -
reject
- Amazon SES determined that the email contained a virus and rejected it. -
bounce
- The recipient's mail server permanently rejected the email. This corresponds to a hard bounce. -
complaint
- The recipient marked the email as spam. -
delivery
- Amazon SES successfully delivered the email to the recipient's mail server. -
open
- The recipient received the email and opened it in their email client. -
click
- The recipient clicked one or more links in the email. -
renderingFailure
- Amazon SES did not send the email because of a template rendering issue.
Sourcepub fn set_matching_event_types(self, input: Option<Vec<EventType>>) -> Self
pub fn set_matching_event_types(self, input: Option<Vec<EventType>>) -> Self
The type of email sending events to publish to the event destination.
-
send
- The call was successful and Amazon SES is attempting to deliver the email. -
reject
- Amazon SES determined that the email contained a virus and rejected it. -
bounce
- The recipient's mail server permanently rejected the email. This corresponds to a hard bounce. -
complaint
- The recipient marked the email as spam. -
delivery
- Amazon SES successfully delivered the email to the recipient's mail server. -
open
- The recipient received the email and opened it in their email client. -
click
- The recipient clicked one or more links in the email. -
renderingFailure
- Amazon SES did not send the email because of a template rendering issue.
Sourcepub fn get_matching_event_types(&self) -> &Option<Vec<EventType>>
pub fn get_matching_event_types(&self) -> &Option<Vec<EventType>>
The type of email sending events to publish to the event destination.
-
send
- The call was successful and Amazon SES is attempting to deliver the email. -
reject
- Amazon SES determined that the email contained a virus and rejected it. -
bounce
- The recipient's mail server permanently rejected the email. This corresponds to a hard bounce. -
complaint
- The recipient marked the email as spam. -
delivery
- Amazon SES successfully delivered the email to the recipient's mail server. -
open
- The recipient received the email and opened it in their email client. -
click
- The recipient clicked one or more links in the email. -
renderingFailure
- Amazon SES did not send the email because of a template rendering issue.
Sourcepub fn kinesis_firehose_destination(
self,
input: KinesisFirehoseDestination,
) -> Self
pub fn kinesis_firehose_destination( self, input: KinesisFirehoseDestination, ) -> Self
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
Sourcepub fn set_kinesis_firehose_destination(
self,
input: Option<KinesisFirehoseDestination>,
) -> Self
pub fn set_kinesis_firehose_destination( self, input: Option<KinesisFirehoseDestination>, ) -> Self
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
Sourcepub fn get_kinesis_firehose_destination(
&self,
) -> &Option<KinesisFirehoseDestination>
pub fn get_kinesis_firehose_destination( &self, ) -> &Option<KinesisFirehoseDestination>
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
Sourcepub fn cloud_watch_destination(self, input: CloudWatchDestination) -> Self
pub fn cloud_watch_destination(self, input: CloudWatchDestination) -> Self
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
Sourcepub fn set_cloud_watch_destination(
self,
input: Option<CloudWatchDestination>,
) -> Self
pub fn set_cloud_watch_destination( self, input: Option<CloudWatchDestination>, ) -> Self
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
Sourcepub fn get_cloud_watch_destination(&self) -> &Option<CloudWatchDestination>
pub fn get_cloud_watch_destination(&self) -> &Option<CloudWatchDestination>
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
Sourcepub fn sns_destination(self, input: SnsDestination) -> Self
pub fn sns_destination(self, input: SnsDestination) -> Self
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
Sourcepub fn set_sns_destination(self, input: Option<SnsDestination>) -> Self
pub fn set_sns_destination(self, input: Option<SnsDestination>) -> Self
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
Sourcepub fn get_sns_destination(&self) -> &Option<SnsDestination>
pub fn get_sns_destination(&self) -> &Option<SnsDestination>
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
Sourcepub fn build(self) -> Result<EventDestination, BuildError>
pub fn build(self) -> Result<EventDestination, BuildError>
Consumes the builder and constructs a EventDestination
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for EventDestinationBuilder
impl Clone for EventDestinationBuilder
Source§fn clone(&self) -> EventDestinationBuilder
fn clone(&self) -> EventDestinationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EventDestinationBuilder
impl Debug for EventDestinationBuilder
Source§impl Default for EventDestinationBuilder
impl Default for EventDestinationBuilder
Source§fn default() -> EventDestinationBuilder
fn default() -> EventDestinationBuilder
Source§impl PartialEq for EventDestinationBuilder
impl PartialEq for EventDestinationBuilder
impl StructuralPartialEq for EventDestinationBuilder
Auto Trait Implementations§
impl Freeze for EventDestinationBuilder
impl RefUnwindSafe for EventDestinationBuilder
impl Send for EventDestinationBuilder
impl Sync for EventDestinationBuilder
impl Unpin for EventDestinationBuilder
impl UnwindSafe for EventDestinationBuilder
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);