#[non_exhaustive]pub struct MessageResultBuilder { /* private fields */ }Expand description
A builder for MessageResult.
Implementations§
Source§impl MessageResultBuilder
impl MessageResultBuilder
Sourcepub fn delivery_status(self, input: DeliveryStatus) -> Self
pub fn delivery_status(self, input: DeliveryStatus) -> Self
The delivery status of the message. Possible values are:
-
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
-
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
-
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
-
SUCCESSFUL - The message was successfully delivered to the endpoint address.
-
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
-
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
-
UNKNOWN_FAILURE - An unknown error occurred.
Sourcepub fn set_delivery_status(self, input: Option<DeliveryStatus>) -> Self
pub fn set_delivery_status(self, input: Option<DeliveryStatus>) -> Self
The delivery status of the message. Possible values are:
-
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
-
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
-
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
-
SUCCESSFUL - The message was successfully delivered to the endpoint address.
-
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
-
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
-
UNKNOWN_FAILURE - An unknown error occurred.
Sourcepub fn get_delivery_status(&self) -> &Option<DeliveryStatus>
pub fn get_delivery_status(&self) -> &Option<DeliveryStatus>
The delivery status of the message. Possible values are:
-
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
-
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
-
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
-
SUCCESSFUL - The message was successfully delivered to the endpoint address.
-
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
-
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
-
UNKNOWN_FAILURE - An unknown error occurred.
Sourcepub fn message_id(self, input: impl Into<String>) -> Self
pub fn message_id(self, input: impl Into<String>) -> Self
The unique identifier for the message that was sent.
Sourcepub fn set_message_id(self, input: Option<String>) -> Self
pub fn set_message_id(self, input: Option<String>) -> Self
The unique identifier for the message that was sent.
Sourcepub fn get_message_id(&self) -> &Option<String>
pub fn get_message_id(&self) -> &Option<String>
The unique identifier for the message that was sent.
Sourcepub fn status_code(self, input: i32) -> Self
pub fn status_code(self, input: i32) -> Self
The downstream service status code for delivering the message.
This field is required.Sourcepub fn set_status_code(self, input: Option<i32>) -> Self
pub fn set_status_code(self, input: Option<i32>) -> Self
The downstream service status code for delivering the message.
Sourcepub fn get_status_code(&self) -> &Option<i32>
pub fn get_status_code(&self) -> &Option<i32>
The downstream service status code for delivering the message.
Sourcepub fn status_message(self, input: impl Into<String>) -> Self
pub fn status_message(self, input: impl Into<String>) -> Self
The status message for delivering the message.
Sourcepub fn set_status_message(self, input: Option<String>) -> Self
pub fn set_status_message(self, input: Option<String>) -> Self
The status message for delivering the message.
Sourcepub fn get_status_message(&self) -> &Option<String>
pub fn get_status_message(&self) -> &Option<String>
The status message for delivering the message.
Sourcepub fn updated_token(self, input: impl Into<String>) -> Self
pub fn updated_token(self, input: impl Into<String>) -> Self
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
Sourcepub fn set_updated_token(self, input: Option<String>) -> Self
pub fn set_updated_token(self, input: Option<String>) -> Self
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
Sourcepub fn get_updated_token(&self) -> &Option<String>
pub fn get_updated_token(&self) -> &Option<String>
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
Sourcepub fn build(self) -> MessageResult
pub fn build(self) -> MessageResult
Consumes the builder and constructs a MessageResult.
Trait Implementations§
Source§impl Clone for MessageResultBuilder
impl Clone for MessageResultBuilder
Source§fn clone(&self) -> MessageResultBuilder
fn clone(&self) -> MessageResultBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for MessageResultBuilder
impl Debug for MessageResultBuilder
Source§impl Default for MessageResultBuilder
impl Default for MessageResultBuilder
Source§fn default() -> MessageResultBuilder
fn default() -> MessageResultBuilder
Source§impl PartialEq for MessageResultBuilder
impl PartialEq for MessageResultBuilder
impl StructuralPartialEq for MessageResultBuilder
Auto Trait Implementations§
impl Freeze for MessageResultBuilder
impl RefUnwindSafe for MessageResultBuilder
impl Send for MessageResultBuilder
impl Sync for MessageResultBuilder
impl Unpin for MessageResultBuilder
impl UnwindSafe for MessageResultBuilder
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);