#[non_exhaustive]pub struct MessageBuilder { /* private fields */ }
Expand description
A builder for Message
.
Implementations§
Source§impl MessageBuilder
impl MessageBuilder
Sourcepub fn message_id(self, input: impl Into<String>) -> Self
pub fn message_id(self, input: impl Into<String>) -> Self
A unique identifier for the message. A MessageId
is considered unique across all Amazon Web Services accounts for an extended period of time.
Sourcepub fn set_message_id(self, input: Option<String>) -> Self
pub fn set_message_id(self, input: Option<String>) -> Self
A unique identifier for the message. A MessageId
is considered unique across all Amazon Web Services accounts for an extended period of time.
Sourcepub fn get_message_id(&self) -> &Option<String>
pub fn get_message_id(&self) -> &Option<String>
A unique identifier for the message. A MessageId
is considered unique across all Amazon Web Services accounts for an extended period of time.
Sourcepub fn receipt_handle(self, input: impl Into<String>) -> Self
pub fn receipt_handle(self, input: impl Into<String>) -> Self
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
Sourcepub fn set_receipt_handle(self, input: Option<String>) -> Self
pub fn set_receipt_handle(self, input: Option<String>) -> Self
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
Sourcepub fn get_receipt_handle(&self) -> &Option<String>
pub fn get_receipt_handle(&self) -> &Option<String>
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
Sourcepub fn md5_of_body(self, input: impl Into<String>) -> Self
pub fn md5_of_body(self, input: impl Into<String>) -> Self
An MD5 digest of the non-URL-encoded message body string.
Sourcepub fn set_md5_of_body(self, input: Option<String>) -> Self
pub fn set_md5_of_body(self, input: Option<String>) -> Self
An MD5 digest of the non-URL-encoded message body string.
Sourcepub fn get_md5_of_body(&self) -> &Option<String>
pub fn get_md5_of_body(&self) -> &Option<String>
An MD5 digest of the non-URL-encoded message body string.
Sourcepub fn attributes(
self,
k: MessageSystemAttributeName,
v: impl Into<String>,
) -> Self
pub fn attributes( self, k: MessageSystemAttributeName, v: impl Into<String>, ) -> Self
Adds a key-value pair to attributes
.
To override the contents of this collection use set_attributes
.
A map of the attributes requested in
to their respective values. Supported attributes:ReceiveMessage
-
ApproximateReceiveCount
-
ApproximateFirstReceiveTimestamp
-
MessageDeduplicationId
-
MessageGroupId
-
SenderId
-
SentTimestamp
-
SequenceNumber
ApproximateFirstReceiveTimestamp
and SentTimestamp
are each returned as an integer representing the epoch time in milliseconds.
Sourcepub fn set_attributes(
self,
input: Option<HashMap<MessageSystemAttributeName, String>>,
) -> Self
pub fn set_attributes( self, input: Option<HashMap<MessageSystemAttributeName, String>>, ) -> Self
A map of the attributes requested in
to their respective values. Supported attributes:ReceiveMessage
-
ApproximateReceiveCount
-
ApproximateFirstReceiveTimestamp
-
MessageDeduplicationId
-
MessageGroupId
-
SenderId
-
SentTimestamp
-
SequenceNumber
ApproximateFirstReceiveTimestamp
and SentTimestamp
are each returned as an integer representing the epoch time in milliseconds.
Sourcepub fn get_attributes(
&self,
) -> &Option<HashMap<MessageSystemAttributeName, String>>
pub fn get_attributes( &self, ) -> &Option<HashMap<MessageSystemAttributeName, String>>
A map of the attributes requested in
to their respective values. Supported attributes:ReceiveMessage
-
ApproximateReceiveCount
-
ApproximateFirstReceiveTimestamp
-
MessageDeduplicationId
-
MessageGroupId
-
SenderId
-
SentTimestamp
-
SequenceNumber
ApproximateFirstReceiveTimestamp
and SentTimestamp
are each returned as an integer representing the epoch time in milliseconds.
Sourcepub fn md5_of_message_attributes(self, input: impl Into<String>) -> Self
pub fn md5_of_message_attributes(self, input: impl Into<String>) -> Self
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
Sourcepub fn set_md5_of_message_attributes(self, input: Option<String>) -> Self
pub fn set_md5_of_message_attributes(self, input: Option<String>) -> Self
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
Sourcepub fn get_md5_of_message_attributes(&self) -> &Option<String>
pub fn get_md5_of_message_attributes(&self) -> &Option<String>
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
Sourcepub fn message_attributes(
self,
k: impl Into<String>,
v: MessageAttributeValue,
) -> Self
pub fn message_attributes( self, k: impl Into<String>, v: MessageAttributeValue, ) -> Self
Adds a key-value pair to message_attributes
.
To override the contents of this collection use set_message_attributes
.
Each message attribute consists of a Name
, Type
, and Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
Sourcepub fn set_message_attributes(
self,
input: Option<HashMap<String, MessageAttributeValue>>,
) -> Self
pub fn set_message_attributes( self, input: Option<HashMap<String, MessageAttributeValue>>, ) -> Self
Each message attribute consists of a Name
, Type
, and Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
Sourcepub fn get_message_attributes(
&self,
) -> &Option<HashMap<String, MessageAttributeValue>>
pub fn get_message_attributes( &self, ) -> &Option<HashMap<String, MessageAttributeValue>>
Each message attribute consists of a Name
, Type
, and Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
Trait Implementations§
Source§impl Clone for MessageBuilder
impl Clone for MessageBuilder
Source§fn clone(&self) -> MessageBuilder
fn clone(&self) -> MessageBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for MessageBuilder
impl Debug for MessageBuilder
Source§impl Default for MessageBuilder
impl Default for MessageBuilder
Source§fn default() -> MessageBuilder
fn default() -> MessageBuilder
Source§impl PartialEq for MessageBuilder
impl PartialEq for MessageBuilder
impl StructuralPartialEq for MessageBuilder
Auto Trait Implementations§
impl Freeze for MessageBuilder
impl RefUnwindSafe for MessageBuilder
impl Send for MessageBuilder
impl Sync for MessageBuilder
impl Unpin for MessageBuilder
impl UnwindSafe for MessageBuilder
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);