#[non_exhaustive]pub struct StartDeviceDiscoveryInput {
pub discovery_type: Option<DiscoveryType>,
pub custom_protocol_detail: Option<HashMap<String, String>>,
pub controller_identifier: Option<String>,
pub connector_association_identifier: Option<String>,
pub account_association_id: Option<String>,
pub authentication_material: Option<String>,
pub authentication_material_type: Option<DiscoveryAuthMaterialType>,
pub client_token: Option<String>,
pub tags: Option<HashMap<String, String>>,
}
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.discovery_type: Option<DiscoveryType>
The discovery type supporting the type of device to be discovered in the device discovery task request.
custom_protocol_detail: Option<HashMap<String, String>>
Additional protocol-specific details required for device discovery, which vary based on the discovery type.
For a DiscoveryType
of CUSTOM
, the string-to-string map must have a key value of Name
set to a non-empty-string.
controller_identifier: Option<String>
The id of the end-user's IoT hub.
connector_association_identifier: Option<String>
The id of the connector association.
account_association_id: Option<String>
The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.
authentication_material: Option<String>
The authentication material required to start the local device discovery job request.
authentication_material_type: Option<DiscoveryAuthMaterialType>
The type of authentication material used for device discovery jobs.
client_token: Option<String>
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
A set of key/value pairs that are used to manage the device discovery request.
Implementations§
Source§impl StartDeviceDiscoveryInput
impl StartDeviceDiscoveryInput
Sourcepub fn discovery_type(&self) -> Option<&DiscoveryType>
pub fn discovery_type(&self) -> Option<&DiscoveryType>
The discovery type supporting the type of device to be discovered in the device discovery task request.
Sourcepub fn custom_protocol_detail(&self) -> Option<&HashMap<String, String>>
pub fn custom_protocol_detail(&self) -> Option<&HashMap<String, String>>
Additional protocol-specific details required for device discovery, which vary based on the discovery type.
For a DiscoveryType
of CUSTOM
, the string-to-string map must have a key value of Name
set to a non-empty-string.
Sourcepub fn controller_identifier(&self) -> Option<&str>
pub fn controller_identifier(&self) -> Option<&str>
The id of the end-user's IoT hub.
Sourcepub fn connector_association_identifier(&self) -> Option<&str>
👎Deprecated since 06-25-2025: ConnectorAssociationIdentifier is deprecated
pub fn connector_association_identifier(&self) -> Option<&str>
The id of the connector association.
Sourcepub fn account_association_id(&self) -> Option<&str>
pub fn account_association_id(&self) -> Option<&str>
The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.
Sourcepub fn authentication_material(&self) -> Option<&str>
pub fn authentication_material(&self) -> Option<&str>
The authentication material required to start the local device discovery job request.
Sourcepub fn authentication_material_type(&self) -> Option<&DiscoveryAuthMaterialType>
pub fn authentication_material_type(&self) -> Option<&DiscoveryAuthMaterialType>
The type of authentication material used for device discovery jobs.
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
👎Deprecated since 06-25-2025: Tags have been deprecated from this api
A set of key/value pairs that are used to manage the device discovery request.
Source§impl StartDeviceDiscoveryInput
impl StartDeviceDiscoveryInput
Sourcepub fn builder() -> StartDeviceDiscoveryInputBuilder
pub fn builder() -> StartDeviceDiscoveryInputBuilder
Creates a new builder-style object to manufacture StartDeviceDiscoveryInput
.
Trait Implementations§
Source§impl Clone for StartDeviceDiscoveryInput
impl Clone for StartDeviceDiscoveryInput
Source§fn clone(&self) -> StartDeviceDiscoveryInput
fn clone(&self) -> StartDeviceDiscoveryInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StartDeviceDiscoveryInput
impl Debug for StartDeviceDiscoveryInput
impl StructuralPartialEq for StartDeviceDiscoveryInput
Auto Trait Implementations§
impl Freeze for StartDeviceDiscoveryInput
impl RefUnwindSafe for StartDeviceDiscoveryInput
impl Send for StartDeviceDiscoveryInput
impl Sync for StartDeviceDiscoveryInput
impl Unpin for StartDeviceDiscoveryInput
impl UnwindSafe for StartDeviceDiscoveryInput
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);