#[non_exhaustive]pub struct BounceActionBuilder { /* private fields */ }
Expand description
A builder for BounceAction
.
Implementations§
Source§impl BounceActionBuilder
impl BounceActionBuilder
Sourcepub fn topic_arn(self, input: impl Into<String>) -> Self
pub fn topic_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
Sourcepub fn set_topic_arn(self, input: Option<String>) -> Self
pub fn set_topic_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
Sourcepub fn get_topic_arn(&self) -> &Option<String>
pub fn get_topic_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
Sourcepub fn smtp_reply_code(self, input: impl Into<String>) -> Self
pub fn smtp_reply_code(self, input: impl Into<String>) -> Self
The SMTP reply code, as defined by RFC 5321.
This field is required.Sourcepub fn set_smtp_reply_code(self, input: Option<String>) -> Self
pub fn set_smtp_reply_code(self, input: Option<String>) -> Self
The SMTP reply code, as defined by RFC 5321.
Sourcepub fn get_smtp_reply_code(&self) -> &Option<String>
pub fn get_smtp_reply_code(&self) -> &Option<String>
The SMTP reply code, as defined by RFC 5321.
Sourcepub fn status_code(self, input: impl Into<String>) -> Self
pub fn status_code(self, input: impl Into<String>) -> Self
The SMTP enhanced status code, as defined by RFC 3463.
Sourcepub fn set_status_code(self, input: Option<String>) -> Self
pub fn set_status_code(self, input: Option<String>) -> Self
The SMTP enhanced status code, as defined by RFC 3463.
Sourcepub fn get_status_code(&self) -> &Option<String>
pub fn get_status_code(&self) -> &Option<String>
The SMTP enhanced status code, as defined by RFC 3463.
Sourcepub fn message(self, input: impl Into<String>) -> Self
pub fn message(self, input: impl Into<String>) -> Self
Human-readable text to include in the bounce message.
This field is required.Sourcepub fn set_message(self, input: Option<String>) -> Self
pub fn set_message(self, input: Option<String>) -> Self
Human-readable text to include in the bounce message.
Sourcepub fn get_message(&self) -> &Option<String>
pub fn get_message(&self) -> &Option<String>
Human-readable text to include in the bounce message.
Sourcepub fn sender(self, input: impl Into<String>) -> Self
pub fn sender(self, input: impl Into<String>) -> Self
The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
This field is required.Sourcepub fn set_sender(self, input: Option<String>) -> Self
pub fn set_sender(self, input: Option<String>) -> Self
The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
Sourcepub fn get_sender(&self) -> &Option<String>
pub fn get_sender(&self) -> &Option<String>
The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
Sourcepub fn build(self) -> Result<BounceAction, BuildError>
pub fn build(self) -> Result<BounceAction, BuildError>
Consumes the builder and constructs a BounceAction
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for BounceActionBuilder
impl Clone for BounceActionBuilder
Source§fn clone(&self) -> BounceActionBuilder
fn clone(&self) -> BounceActionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for BounceActionBuilder
impl Debug for BounceActionBuilder
Source§impl Default for BounceActionBuilder
impl Default for BounceActionBuilder
Source§fn default() -> BounceActionBuilder
fn default() -> BounceActionBuilder
Source§impl PartialEq for BounceActionBuilder
impl PartialEq for BounceActionBuilder
impl StructuralPartialEq for BounceActionBuilder
Auto Trait Implementations§
impl Freeze for BounceActionBuilder
impl RefUnwindSafe for BounceActionBuilder
impl Send for BounceActionBuilder
impl Sync for BounceActionBuilder
impl Unpin for BounceActionBuilder
impl UnwindSafe for BounceActionBuilder
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);