#[non_exhaustive]pub struct MqttHeadersBuilder { /* private fields */ }
Expand description
A builder for MqttHeaders
.
Implementations§
Source§impl MqttHeadersBuilder
impl MqttHeadersBuilder
Sourcepub fn payload_format_indicator(self, input: impl Into<String>) -> Self
pub fn payload_format_indicator(self, input: impl Into<String>) -> Self
An Enum
string value that indicates whether the payload is formatted as UTF-8.
Valid values are UNSPECIFIED_BYTES
and UTF8_DATA
.
For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates.
Sourcepub fn set_payload_format_indicator(self, input: Option<String>) -> Self
pub fn set_payload_format_indicator(self, input: Option<String>) -> Self
An Enum
string value that indicates whether the payload is formatted as UTF-8.
Valid values are UNSPECIFIED_BYTES
and UTF8_DATA
.
For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates.
Sourcepub fn get_payload_format_indicator(&self) -> &Option<String>
pub fn get_payload_format_indicator(&self) -> &Option<String>
An Enum
string value that indicates whether the payload is formatted as UTF-8.
Valid values are UNSPECIFIED_BYTES
and UTF8_DATA
.
For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates.
Sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type from the MQTT Version 5.0 specification.
Supports substitution templates.
Sourcepub fn set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type from the MQTT Version 5.0 specification.
Supports substitution templates.
Sourcepub fn get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &Option<String>
A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type from the MQTT Version 5.0 specification.
Supports substitution templates.
Sourcepub fn response_topic(self, input: impl Into<String>) -> Self
pub fn response_topic(self, input: impl Into<String>) -> Self
A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic from the MQTT Version 5.0 specification.
Supports substitution templates.
Sourcepub fn set_response_topic(self, input: Option<String>) -> Self
pub fn set_response_topic(self, input: Option<String>) -> Self
A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic from the MQTT Version 5.0 specification.
Supports substitution templates.
Sourcepub fn get_response_topic(&self) -> &Option<String>
pub fn get_response_topic(&self) -> &Option<String>
A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic from the MQTT Version 5.0 specification.
Supports substitution templates.
Sourcepub fn correlation_data(self, input: impl Into<String>) -> Self
pub fn correlation_data(self, input: impl Into<String>) -> Self
The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.
For more information, see Correlation Data from the MQTT Version 5.0 specification.
This binary data must be based64-encoded.
Supports substitution templates.
Sourcepub fn set_correlation_data(self, input: Option<String>) -> Self
pub fn set_correlation_data(self, input: Option<String>) -> Self
The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.
For more information, see Correlation Data from the MQTT Version 5.0 specification.
This binary data must be based64-encoded.
Supports substitution templates.
Sourcepub fn get_correlation_data(&self) -> &Option<String>
pub fn get_correlation_data(&self) -> &Option<String>
The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.
For more information, see Correlation Data from the MQTT Version 5.0 specification.
This binary data must be based64-encoded.
Supports substitution templates.
Sourcepub fn message_expiry(self, input: impl Into<String>) -> Self
pub fn message_expiry(self, input: impl Into<String>) -> Self
A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer relevant to the subscriber. The value of messageExpiry
represents the number of seconds before it expires. For more information about the limits of messageExpiry
, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
Supports substitution templates.
Sourcepub fn set_message_expiry(self, input: Option<String>) -> Self
pub fn set_message_expiry(self, input: Option<String>) -> Self
A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer relevant to the subscriber. The value of messageExpiry
represents the number of seconds before it expires. For more information about the limits of messageExpiry
, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
Supports substitution templates.
Sourcepub fn get_message_expiry(&self) -> &Option<String>
pub fn get_message_expiry(&self) -> &Option<String>
A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer relevant to the subscriber. The value of messageExpiry
represents the number of seconds before it expires. For more information about the limits of messageExpiry
, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
Supports substitution templates.
Sourcepub fn user_properties(self, input: UserProperty) -> Self
pub fn user_properties(self, input: UserProperty) -> Self
Appends an item to user_properties
.
To override the contents of this collection use set_user_properties
.
An array of key-value pairs that you define in the MQTT5 header.
Sourcepub fn set_user_properties(self, input: Option<Vec<UserProperty>>) -> Self
pub fn set_user_properties(self, input: Option<Vec<UserProperty>>) -> Self
An array of key-value pairs that you define in the MQTT5 header.
Sourcepub fn get_user_properties(&self) -> &Option<Vec<UserProperty>>
pub fn get_user_properties(&self) -> &Option<Vec<UserProperty>>
An array of key-value pairs that you define in the MQTT5 header.
Sourcepub fn build(self) -> MqttHeaders
pub fn build(self) -> MqttHeaders
Consumes the builder and constructs a MqttHeaders
.
Trait Implementations§
Source§impl Clone for MqttHeadersBuilder
impl Clone for MqttHeadersBuilder
Source§fn clone(&self) -> MqttHeadersBuilder
fn clone(&self) -> MqttHeadersBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for MqttHeadersBuilder
impl Debug for MqttHeadersBuilder
Source§impl Default for MqttHeadersBuilder
impl Default for MqttHeadersBuilder
Source§fn default() -> MqttHeadersBuilder
fn default() -> MqttHeadersBuilder
Source§impl PartialEq for MqttHeadersBuilder
impl PartialEq for MqttHeadersBuilder
impl StructuralPartialEq for MqttHeadersBuilder
Auto Trait Implementations§
impl Freeze for MqttHeadersBuilder
impl RefUnwindSafe for MqttHeadersBuilder
impl Send for MqttHeadersBuilder
impl Sync for MqttHeadersBuilder
impl Unpin for MqttHeadersBuilder
impl UnwindSafe for MqttHeadersBuilder
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);