#[non_exhaustive]pub struct GetConnectionOutput {Show 14 fields
pub connected: bool,
pub thing_name: Option<String>,
pub clean_session: bool,
pub source_ip: Option<String>,
pub source_port: i32,
pub target_ip: Option<String>,
pub target_port: i32,
pub keep_alive_duration: i32,
pub connected_since: i64,
pub disconnected_since: i64,
pub disconnect_reason: Option<String>,
pub session_expiry: i64,
pub client_id: Option<String>,
pub vpc_endpoint_id: Option<String>,
/* private fields */
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.connected: boolThe connection state of the client. Returns true if the client is currently connected, or false if the client is not connected.
thing_name: Option<String>The name of the thing associated with the principal of the MQTT client, if applicable.
clean_session: boolIndicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions.
source_ip: Option<String>The IP address of the client that initiated the connection.
source_port: i32The client's source port.
target_ip: Option<String>The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.
target_port: i32The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
keep_alive_duration: i32The keep-alive interval in seconds that the client specified when establishing the connection.
connected_since: i64Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.
disconnected_since: i64Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.
disconnect_reason: Option<String>The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.
session_expiry: i64The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.
client_id: Option<String>The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection.
vpc_endpoint_id: Option<String>The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.
Implementations§
Source§impl GetConnectionOutput
impl GetConnectionOutput
Sourcepub fn connected(&self) -> bool
pub fn connected(&self) -> bool
The connection state of the client. Returns true if the client is currently connected, or false if the client is not connected.
Sourcepub fn thing_name(&self) -> Option<&str>
pub fn thing_name(&self) -> Option<&str>
The name of the thing associated with the principal of the MQTT client, if applicable.
Sourcepub fn clean_session(&self) -> bool
pub fn clean_session(&self) -> bool
Indicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions.
Sourcepub fn source_ip(&self) -> Option<&str>
pub fn source_ip(&self) -> Option<&str>
The IP address of the client that initiated the connection.
Sourcepub fn source_port(&self) -> i32
pub fn source_port(&self) -> i32
The client's source port.
Sourcepub fn target_ip(&self) -> Option<&str>
pub fn target_ip(&self) -> Option<&str>
The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.
Sourcepub fn target_port(&self) -> i32
pub fn target_port(&self) -> i32
The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
Sourcepub fn keep_alive_duration(&self) -> i32
pub fn keep_alive_duration(&self) -> i32
The keep-alive interval in seconds that the client specified when establishing the connection.
Sourcepub fn connected_since(&self) -> i64
pub fn connected_since(&self) -> i64
Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.
Sourcepub fn disconnected_since(&self) -> i64
pub fn disconnected_since(&self) -> i64
Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.
Sourcepub fn disconnect_reason(&self) -> Option<&str>
pub fn disconnect_reason(&self) -> Option<&str>
The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.
Sourcepub fn session_expiry(&self) -> i64
pub fn session_expiry(&self) -> i64
The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.
Sourcepub fn client_id(&self) -> Option<&str>
pub fn client_id(&self) -> Option<&str>
The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection.
Sourcepub fn vpc_endpoint_id(&self) -> Option<&str>
pub fn vpc_endpoint_id(&self) -> Option<&str>
The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.
Source§impl GetConnectionOutput
impl GetConnectionOutput
Sourcepub fn builder() -> GetConnectionOutputBuilder
pub fn builder() -> GetConnectionOutputBuilder
Creates a new builder-style object to manufacture GetConnectionOutput.
Trait Implementations§
Source§impl Clone for GetConnectionOutput
impl Clone for GetConnectionOutput
Source§fn clone(&self) -> GetConnectionOutput
fn clone(&self) -> GetConnectionOutput
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GetConnectionOutput
impl Debug for GetConnectionOutput
Source§impl PartialEq for GetConnectionOutput
impl PartialEq for GetConnectionOutput
Source§fn eq(&self, other: &GetConnectionOutput) -> bool
fn eq(&self, other: &GetConnectionOutput) -> bool
self and other values to be equal, and is used by ==.Source§impl RequestId for GetConnectionOutput
impl RequestId for GetConnectionOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for GetConnectionOutput
Auto Trait Implementations§
impl Freeze for GetConnectionOutput
impl RefUnwindSafe for GetConnectionOutput
impl Send for GetConnectionOutput
impl Sync for GetConnectionOutput
impl Unpin for GetConnectionOutput
impl UnsafeUnpin for GetConnectionOutput
impl UnwindSafe for GetConnectionOutput
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>
renamed to 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);