Struct Client

Source
pub struct Client { /* private fields */ }
Expand description

Client for AWS IoT Wireless

Client for invoking operations on AWS IoT Wireless. Each operation on AWS IoT Wireless is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_iotwireless::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_iotwireless::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

§Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateAwsAccountWithPartnerAccount operation has a Client::associate_aws_account_with_partner_account, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_aws_account_with_partner_account()
    .client_request_token("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations§

Source§

impl Client

Source

pub fn associate_aws_account_with_partner_account( &self, ) -> AssociateAwsAccountWithPartnerAccountFluentBuilder

Constructs a fluent builder for the AssociateAwsAccountWithPartnerAccount operation.

Source§

impl Client

Source

pub fn associate_multicast_group_with_fuota_task( &self, ) -> AssociateMulticastGroupWithFuotaTaskFluentBuilder

Constructs a fluent builder for the AssociateMulticastGroupWithFuotaTask operation.

Source§

impl Client

Source

pub fn associate_wireless_device_with_fuota_task( &self, ) -> AssociateWirelessDeviceWithFuotaTaskFluentBuilder

Constructs a fluent builder for the AssociateWirelessDeviceWithFuotaTask operation.

Source§

impl Client

Source

pub fn associate_wireless_device_with_multicast_group( &self, ) -> AssociateWirelessDeviceWithMulticastGroupFluentBuilder

Constructs a fluent builder for the AssociateWirelessDeviceWithMulticastGroup operation.

Source§

impl Client

Source

pub fn associate_wireless_device_with_thing( &self, ) -> AssociateWirelessDeviceWithThingFluentBuilder

Constructs a fluent builder for the AssociateWirelessDeviceWithThing operation.

Source§

impl Client

Source

pub fn associate_wireless_gateway_with_certificate( &self, ) -> AssociateWirelessGatewayWithCertificateFluentBuilder

Constructs a fluent builder for the AssociateWirelessGatewayWithCertificate operation.

Source§

impl Client

Source

pub fn associate_wireless_gateway_with_thing( &self, ) -> AssociateWirelessGatewayWithThingFluentBuilder

Constructs a fluent builder for the AssociateWirelessGatewayWithThing operation.

Source§

impl Client

Source

pub fn cancel_multicast_group_session( &self, ) -> CancelMulticastGroupSessionFluentBuilder

Constructs a fluent builder for the CancelMulticastGroupSession operation.

Source§

impl Client

Source

pub fn create_destination(&self) -> CreateDestinationFluentBuilder

Constructs a fluent builder for the CreateDestination operation.

Source§

impl Client

Source

pub fn create_device_profile(&self) -> CreateDeviceProfileFluentBuilder

Constructs a fluent builder for the CreateDeviceProfile operation.

Source§

impl Client

Source

pub fn create_fuota_task(&self) -> CreateFuotaTaskFluentBuilder

Constructs a fluent builder for the CreateFuotaTask operation.

Source§

impl Client

Source

pub fn create_multicast_group(&self) -> CreateMulticastGroupFluentBuilder

Constructs a fluent builder for the CreateMulticastGroup operation.

Source§

impl Client

Source

pub fn create_network_analyzer_configuration( &self, ) -> CreateNetworkAnalyzerConfigurationFluentBuilder

Constructs a fluent builder for the CreateNetworkAnalyzerConfiguration operation.

Source§

impl Client

Source

pub fn create_service_profile(&self) -> CreateServiceProfileFluentBuilder

Constructs a fluent builder for the CreateServiceProfile operation.

Source§

impl Client

Source

pub fn create_wireless_device(&self) -> CreateWirelessDeviceFluentBuilder

Constructs a fluent builder for the CreateWirelessDevice operation.

Source§

impl Client

Source

pub fn create_wireless_gateway(&self) -> CreateWirelessGatewayFluentBuilder

Constructs a fluent builder for the CreateWirelessGateway operation.

Source§

impl Client

Source

pub fn create_wireless_gateway_task( &self, ) -> CreateWirelessGatewayTaskFluentBuilder

Constructs a fluent builder for the CreateWirelessGatewayTask operation.

Source§

impl Client

Source

pub fn create_wireless_gateway_task_definition( &self, ) -> CreateWirelessGatewayTaskDefinitionFluentBuilder

Constructs a fluent builder for the CreateWirelessGatewayTaskDefinition operation.

Source§

impl Client

Source

pub fn delete_destination(&self) -> DeleteDestinationFluentBuilder

Constructs a fluent builder for the DeleteDestination operation.

Source§

impl Client

Source

pub fn delete_device_profile(&self) -> DeleteDeviceProfileFluentBuilder

Constructs a fluent builder for the DeleteDeviceProfile operation.

Source§

impl Client

Source

pub fn delete_fuota_task(&self) -> DeleteFuotaTaskFluentBuilder

Constructs a fluent builder for the DeleteFuotaTask operation.

Source§

impl Client

Source

pub fn delete_multicast_group(&self) -> DeleteMulticastGroupFluentBuilder

Constructs a fluent builder for the DeleteMulticastGroup operation.

Source§

impl Client

Source

pub fn delete_network_analyzer_configuration( &self, ) -> DeleteNetworkAnalyzerConfigurationFluentBuilder

Constructs a fluent builder for the DeleteNetworkAnalyzerConfiguration operation.

Source§

impl Client

Source

pub fn delete_queued_messages(&self) -> DeleteQueuedMessagesFluentBuilder

Constructs a fluent builder for the DeleteQueuedMessages operation.

Source§

impl Client

Source

pub fn delete_service_profile(&self) -> DeleteServiceProfileFluentBuilder

Constructs a fluent builder for the DeleteServiceProfile operation.

Source§

impl Client

Source

pub fn delete_wireless_device(&self) -> DeleteWirelessDeviceFluentBuilder

Constructs a fluent builder for the DeleteWirelessDevice operation.

Source§

impl Client

Source

pub fn delete_wireless_device_import_task( &self, ) -> DeleteWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the DeleteWirelessDeviceImportTask operation.

Source§

impl Client

Source

pub fn delete_wireless_gateway(&self) -> DeleteWirelessGatewayFluentBuilder

Constructs a fluent builder for the DeleteWirelessGateway operation.

Source§

impl Client

Source

pub fn delete_wireless_gateway_task( &self, ) -> DeleteWirelessGatewayTaskFluentBuilder

Constructs a fluent builder for the DeleteWirelessGatewayTask operation.

Source§

impl Client

Source

pub fn delete_wireless_gateway_task_definition( &self, ) -> DeleteWirelessGatewayTaskDefinitionFluentBuilder

Constructs a fluent builder for the DeleteWirelessGatewayTaskDefinition operation.

Source§

impl Client

Source

pub fn deregister_wireless_device( &self, ) -> DeregisterWirelessDeviceFluentBuilder

Constructs a fluent builder for the DeregisterWirelessDevice operation.

Source§

impl Client

Source

pub fn disassociate_aws_account_from_partner_account( &self, ) -> DisassociateAwsAccountFromPartnerAccountFluentBuilder

Constructs a fluent builder for the DisassociateAwsAccountFromPartnerAccount operation.

Source§

impl Client

Source

pub fn disassociate_multicast_group_from_fuota_task( &self, ) -> DisassociateMulticastGroupFromFuotaTaskFluentBuilder

Constructs a fluent builder for the DisassociateMulticastGroupFromFuotaTask operation.

Source§

impl Client

Source

pub fn disassociate_wireless_device_from_fuota_task( &self, ) -> DisassociateWirelessDeviceFromFuotaTaskFluentBuilder

Constructs a fluent builder for the DisassociateWirelessDeviceFromFuotaTask operation.

Source§

impl Client

Source

pub fn disassociate_wireless_device_from_multicast_group( &self, ) -> DisassociateWirelessDeviceFromMulticastGroupFluentBuilder

Constructs a fluent builder for the DisassociateWirelessDeviceFromMulticastGroup operation.

Source§

impl Client

Source

pub fn disassociate_wireless_device_from_thing( &self, ) -> DisassociateWirelessDeviceFromThingFluentBuilder

Constructs a fluent builder for the DisassociateWirelessDeviceFromThing operation.

Source§

impl Client

Source

pub fn disassociate_wireless_gateway_from_certificate( &self, ) -> DisassociateWirelessGatewayFromCertificateFluentBuilder

Constructs a fluent builder for the DisassociateWirelessGatewayFromCertificate operation.

Source§

impl Client

Source

pub fn disassociate_wireless_gateway_from_thing( &self, ) -> DisassociateWirelessGatewayFromThingFluentBuilder

Constructs a fluent builder for the DisassociateWirelessGatewayFromThing operation.

Source§

impl Client

Source

pub fn get_destination(&self) -> GetDestinationFluentBuilder

Constructs a fluent builder for the GetDestination operation.

Source§

impl Client

Source

pub fn get_device_profile(&self) -> GetDeviceProfileFluentBuilder

Constructs a fluent builder for the GetDeviceProfile operation.

Source§

impl Client

Source

pub fn get_event_configuration_by_resource_types( &self, ) -> GetEventConfigurationByResourceTypesFluentBuilder

Constructs a fluent builder for the GetEventConfigurationByResourceTypes operation.

Source§

impl Client

Source

pub fn get_fuota_task(&self) -> GetFuotaTaskFluentBuilder

Constructs a fluent builder for the GetFuotaTask operation.

Source§

impl Client

Source

pub fn get_log_levels_by_resource_types( &self, ) -> GetLogLevelsByResourceTypesFluentBuilder

Constructs a fluent builder for the GetLogLevelsByResourceTypes operation.

Source§

impl Client

Source

pub fn get_metric_configuration(&self) -> GetMetricConfigurationFluentBuilder

Constructs a fluent builder for the GetMetricConfiguration operation.

Source§

impl Client

Source

pub fn get_metrics(&self) -> GetMetricsFluentBuilder

Constructs a fluent builder for the GetMetrics operation.

Source§

impl Client

Source

pub fn get_multicast_group(&self) -> GetMulticastGroupFluentBuilder

Constructs a fluent builder for the GetMulticastGroup operation.

Source§

impl Client

Source

pub fn get_multicast_group_session( &self, ) -> GetMulticastGroupSessionFluentBuilder

Constructs a fluent builder for the GetMulticastGroupSession operation.

Source§

impl Client

Source

pub fn get_network_analyzer_configuration( &self, ) -> GetNetworkAnalyzerConfigurationFluentBuilder

Constructs a fluent builder for the GetNetworkAnalyzerConfiguration operation.

Source§

impl Client

Source

pub fn get_partner_account(&self) -> GetPartnerAccountFluentBuilder

Constructs a fluent builder for the GetPartnerAccount operation.

Source§

impl Client

Source

pub fn get_position(&self) -> GetPositionFluentBuilder

👎Deprecated: This operation is no longer supported.

Constructs a fluent builder for the GetPosition operation.

Source§

impl Client

Source

pub fn get_position_configuration( &self, ) -> GetPositionConfigurationFluentBuilder

👎Deprecated: This operation is no longer supported.

Constructs a fluent builder for the GetPositionConfiguration operation.

Source§

impl Client

Source

pub fn get_position_estimate(&self) -> GetPositionEstimateFluentBuilder

Constructs a fluent builder for the GetPositionEstimate operation.

Source§

impl Client

Source

pub fn get_resource_event_configuration( &self, ) -> GetResourceEventConfigurationFluentBuilder

Constructs a fluent builder for the GetResourceEventConfiguration operation.

Source§

impl Client

Source

pub fn get_resource_log_level(&self) -> GetResourceLogLevelFluentBuilder

Constructs a fluent builder for the GetResourceLogLevel operation.

Source§

impl Client

Source

pub fn get_resource_position(&self) -> GetResourcePositionFluentBuilder

Constructs a fluent builder for the GetResourcePosition operation.

Source§

impl Client

Source

pub fn get_service_endpoint(&self) -> GetServiceEndpointFluentBuilder

Constructs a fluent builder for the GetServiceEndpoint operation.

Source§

impl Client

Source

pub fn get_service_profile(&self) -> GetServiceProfileFluentBuilder

Constructs a fluent builder for the GetServiceProfile operation.

Source§

impl Client

Source

pub fn get_wireless_device(&self) -> GetWirelessDeviceFluentBuilder

Constructs a fluent builder for the GetWirelessDevice operation.

Source§

impl Client

Source

pub fn get_wireless_device_import_task( &self, ) -> GetWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the GetWirelessDeviceImportTask operation.

Source§

impl Client

Source

pub fn get_wireless_device_statistics( &self, ) -> GetWirelessDeviceStatisticsFluentBuilder

Constructs a fluent builder for the GetWirelessDeviceStatistics operation.

Source§

impl Client

Source

pub fn get_wireless_gateway(&self) -> GetWirelessGatewayFluentBuilder

Constructs a fluent builder for the GetWirelessGateway operation.

Source§

impl Client

Source

pub fn get_wireless_gateway_certificate( &self, ) -> GetWirelessGatewayCertificateFluentBuilder

Constructs a fluent builder for the GetWirelessGatewayCertificate operation.

Source§

impl Client

Source

pub fn get_wireless_gateway_firmware_information( &self, ) -> GetWirelessGatewayFirmwareInformationFluentBuilder

Constructs a fluent builder for the GetWirelessGatewayFirmwareInformation operation.

Source§

impl Client

Source

pub fn get_wireless_gateway_statistics( &self, ) -> GetWirelessGatewayStatisticsFluentBuilder

Constructs a fluent builder for the GetWirelessGatewayStatistics operation.

Source§

impl Client

Source

pub fn get_wireless_gateway_task(&self) -> GetWirelessGatewayTaskFluentBuilder

Constructs a fluent builder for the GetWirelessGatewayTask operation.

Source§

impl Client

Source

pub fn get_wireless_gateway_task_definition( &self, ) -> GetWirelessGatewayTaskDefinitionFluentBuilder

Constructs a fluent builder for the GetWirelessGatewayTaskDefinition operation.

Source§

impl Client

Source

pub fn list_destinations(&self) -> ListDestinationsFluentBuilder

Constructs a fluent builder for the ListDestinations operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_device_profiles(&self) -> ListDeviceProfilesFluentBuilder

Constructs a fluent builder for the ListDeviceProfiles operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_devices_for_wireless_device_import_task( &self, ) -> ListDevicesForWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the ListDevicesForWirelessDeviceImportTask operation.

Source§

impl Client

Source

pub fn list_event_configurations(&self) -> ListEventConfigurationsFluentBuilder

Constructs a fluent builder for the ListEventConfigurations operation.

Source§

impl Client

Source

pub fn list_fuota_tasks(&self) -> ListFuotaTasksFluentBuilder

Constructs a fluent builder for the ListFuotaTasks operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_multicast_groups(&self) -> ListMulticastGroupsFluentBuilder

Constructs a fluent builder for the ListMulticastGroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_multicast_groups_by_fuota_task( &self, ) -> ListMulticastGroupsByFuotaTaskFluentBuilder

Constructs a fluent builder for the ListMulticastGroupsByFuotaTask operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_network_analyzer_configurations( &self, ) -> ListNetworkAnalyzerConfigurationsFluentBuilder

Constructs a fluent builder for the ListNetworkAnalyzerConfigurations operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_partner_accounts(&self) -> ListPartnerAccountsFluentBuilder

Constructs a fluent builder for the ListPartnerAccounts operation.

Source§

impl Client

Source

pub fn list_position_configurations( &self, ) -> ListPositionConfigurationsFluentBuilder

👎Deprecated: This operation is no longer supported.

Constructs a fluent builder for the ListPositionConfigurations operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_queued_messages(&self) -> ListQueuedMessagesFluentBuilder

Constructs a fluent builder for the ListQueuedMessages operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_service_profiles(&self) -> ListServiceProfilesFluentBuilder

Constructs a fluent builder for the ListServiceProfiles operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

Source§

impl Client

Source

pub fn list_wireless_device_import_tasks( &self, ) -> ListWirelessDeviceImportTasksFluentBuilder

Constructs a fluent builder for the ListWirelessDeviceImportTasks operation.

Source§

impl Client

Source

pub fn list_wireless_devices(&self) -> ListWirelessDevicesFluentBuilder

Constructs a fluent builder for the ListWirelessDevices operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_wireless_gateway_task_definitions( &self, ) -> ListWirelessGatewayTaskDefinitionsFluentBuilder

Constructs a fluent builder for the ListWirelessGatewayTaskDefinitions operation.

Source§

impl Client

Source

pub fn list_wireless_gateways(&self) -> ListWirelessGatewaysFluentBuilder

Constructs a fluent builder for the ListWirelessGateways operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn put_position_configuration( &self, ) -> PutPositionConfigurationFluentBuilder

👎Deprecated: This operation is no longer supported.

Constructs a fluent builder for the PutPositionConfiguration operation.

Source§

impl Client

Source

pub fn put_resource_log_level(&self) -> PutResourceLogLevelFluentBuilder

Constructs a fluent builder for the PutResourceLogLevel operation.

Source§

impl Client

Source

pub fn reset_all_resource_log_levels( &self, ) -> ResetAllResourceLogLevelsFluentBuilder

Constructs a fluent builder for the ResetAllResourceLogLevels operation.

Source§

impl Client

Source

pub fn reset_resource_log_level(&self) -> ResetResourceLogLevelFluentBuilder

Constructs a fluent builder for the ResetResourceLogLevel operation.

Source§

impl Client

Source

pub fn send_data_to_multicast_group( &self, ) -> SendDataToMulticastGroupFluentBuilder

Constructs a fluent builder for the SendDataToMulticastGroup operation.

Source§

impl Client

Source

pub fn send_data_to_wireless_device( &self, ) -> SendDataToWirelessDeviceFluentBuilder

Constructs a fluent builder for the SendDataToWirelessDevice operation.

Source§

impl Client

Source

pub fn start_bulk_associate_wireless_device_with_multicast_group( &self, ) -> StartBulkAssociateWirelessDeviceWithMulticastGroupFluentBuilder

Constructs a fluent builder for the StartBulkAssociateWirelessDeviceWithMulticastGroup operation.

Source§

impl Client

Source

pub fn start_bulk_disassociate_wireless_device_from_multicast_group( &self, ) -> StartBulkDisassociateWirelessDeviceFromMulticastGroupFluentBuilder

Constructs a fluent builder for the StartBulkDisassociateWirelessDeviceFromMulticastGroup operation.

Source§

impl Client

Source

pub fn start_fuota_task(&self) -> StartFuotaTaskFluentBuilder

Constructs a fluent builder for the StartFuotaTask operation.

Source§

impl Client

Source

pub fn start_multicast_group_session( &self, ) -> StartMulticastGroupSessionFluentBuilder

Constructs a fluent builder for the StartMulticastGroupSession operation.

Source§

impl Client

Source

pub fn start_single_wireless_device_import_task( &self, ) -> StartSingleWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the StartSingleWirelessDeviceImportTask operation.

Source§

impl Client

Source

pub fn start_wireless_device_import_task( &self, ) -> StartWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the StartWirelessDeviceImportTask operation.

Source§

impl Client

Source

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

Source§

impl Client

Source

pub fn test_wireless_device(&self) -> TestWirelessDeviceFluentBuilder

Constructs a fluent builder for the TestWirelessDevice operation.

Source§

impl Client

Source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

Source§

impl Client

Source

pub fn update_destination(&self) -> UpdateDestinationFluentBuilder

Constructs a fluent builder for the UpdateDestination operation.

Source§

impl Client

Source

pub fn update_event_configuration_by_resource_types( &self, ) -> UpdateEventConfigurationByResourceTypesFluentBuilder

Constructs a fluent builder for the UpdateEventConfigurationByResourceTypes operation.

Source§

impl Client

Source

pub fn update_fuota_task(&self) -> UpdateFuotaTaskFluentBuilder

Constructs a fluent builder for the UpdateFuotaTask operation.

Source§

impl Client

Source

pub fn update_log_levels_by_resource_types( &self, ) -> UpdateLogLevelsByResourceTypesFluentBuilder

Constructs a fluent builder for the UpdateLogLevelsByResourceTypes operation.

Source§

impl Client

Source

pub fn update_metric_configuration( &self, ) -> UpdateMetricConfigurationFluentBuilder

Constructs a fluent builder for the UpdateMetricConfiguration operation.

Source§

impl Client

Source

pub fn update_multicast_group(&self) -> UpdateMulticastGroupFluentBuilder

Constructs a fluent builder for the UpdateMulticastGroup operation.

Source§

impl Client

Source

pub fn update_network_analyzer_configuration( &self, ) -> UpdateNetworkAnalyzerConfigurationFluentBuilder

Constructs a fluent builder for the UpdateNetworkAnalyzerConfiguration operation.

Source§

impl Client

Source

pub fn update_partner_account(&self) -> UpdatePartnerAccountFluentBuilder

Constructs a fluent builder for the UpdatePartnerAccount operation.

Source§

impl Client

Source

pub fn update_position(&self) -> UpdatePositionFluentBuilder

👎Deprecated: This operation is no longer supported.

Constructs a fluent builder for the UpdatePosition operation.

Source§

impl Client

Source

pub fn update_resource_event_configuration( &self, ) -> UpdateResourceEventConfigurationFluentBuilder

Constructs a fluent builder for the UpdateResourceEventConfiguration operation.

Source§

impl Client

Source

pub fn update_resource_position(&self) -> UpdateResourcePositionFluentBuilder

Constructs a fluent builder for the UpdateResourcePosition operation.

Source§

impl Client

Source

pub fn update_wireless_device(&self) -> UpdateWirelessDeviceFluentBuilder

Constructs a fluent builder for the UpdateWirelessDevice operation.

Source§

impl Client

Source

pub fn update_wireless_device_import_task( &self, ) -> UpdateWirelessDeviceImportTaskFluentBuilder

Constructs a fluent builder for the UpdateWirelessDeviceImportTask operation.

Source§

impl Client

Source

pub fn update_wireless_gateway(&self) -> UpdateWirelessGatewayFluentBuilder

Constructs a fluent builder for the UpdateWirelessGateway operation.

Source§

impl Client

Source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

  • Retries or timeouts are enabled without a sleep_impl configured.
  • Identity caching is enabled without a sleep_impl and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

Source

pub fn config(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
  • This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,