Struct Client

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

Client for AWS Network Manager

Client for invoking operations on AWS Network Manager. Each operation on AWS Network Manager 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_networkmanager::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_networkmanager::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 AcceptAttachment operation has a Client::accept_attachment, 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.accept_attachment()
    .attachment_id("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 accept_attachment(&self) -> AcceptAttachmentFluentBuilder

Constructs a fluent builder for the AcceptAttachment operation.

Source§

impl Client

Source

pub fn associate_connect_peer(&self) -> AssociateConnectPeerFluentBuilder

Constructs a fluent builder for the AssociateConnectPeer operation.

Source§

impl Client

Source

pub fn associate_customer_gateway( &self, ) -> AssociateCustomerGatewayFluentBuilder

Constructs a fluent builder for the AssociateCustomerGateway operation.

Source§

impl Client

Constructs a fluent builder for the AssociateLink operation.

Source§

impl Client

Source

pub fn associate_transit_gateway_connect_peer( &self, ) -> AssociateTransitGatewayConnectPeerFluentBuilder

Constructs a fluent builder for the AssociateTransitGatewayConnectPeer operation.

Source§

impl Client

Source

pub fn create_connect_attachment(&self) -> CreateConnectAttachmentFluentBuilder

Constructs a fluent builder for the CreateConnectAttachment operation.

Source§

impl Client

Source

pub fn create_connect_peer(&self) -> CreateConnectPeerFluentBuilder

Constructs a fluent builder for the CreateConnectPeer operation.

Source§

impl Client

Source

pub fn create_connection(&self) -> CreateConnectionFluentBuilder

Constructs a fluent builder for the CreateConnection operation.

Source§

impl Client

Source

pub fn create_core_network(&self) -> CreateCoreNetworkFluentBuilder

Constructs a fluent builder for the CreateCoreNetwork operation.

Source§

impl Client

Source

pub fn create_device(&self) -> CreateDeviceFluentBuilder

Constructs a fluent builder for the CreateDevice operation.

Source§

impl Client

Source

pub fn create_direct_connect_gateway_attachment( &self, ) -> CreateDirectConnectGatewayAttachmentFluentBuilder

Constructs a fluent builder for the CreateDirectConnectGatewayAttachment operation.

Source§

impl Client

Source

pub fn create_global_network(&self) -> CreateGlobalNetworkFluentBuilder

Constructs a fluent builder for the CreateGlobalNetwork operation.

Source§

impl Client

Constructs a fluent builder for the CreateLink operation.

Source§

impl Client

Source

pub fn create_site(&self) -> CreateSiteFluentBuilder

Constructs a fluent builder for the CreateSite operation.

Source§

impl Client

Source

pub fn create_site_to_site_vpn_attachment( &self, ) -> CreateSiteToSiteVpnAttachmentFluentBuilder

Constructs a fluent builder for the CreateSiteToSiteVpnAttachment operation.

Source§

impl Client

Source

pub fn create_transit_gateway_peering( &self, ) -> CreateTransitGatewayPeeringFluentBuilder

Constructs a fluent builder for the CreateTransitGatewayPeering operation.

Source§

impl Client

Source

pub fn create_transit_gateway_route_table_attachment( &self, ) -> CreateTransitGatewayRouteTableAttachmentFluentBuilder

Constructs a fluent builder for the CreateTransitGatewayRouteTableAttachment operation.

Source§

impl Client

Source

pub fn create_vpc_attachment(&self) -> CreateVpcAttachmentFluentBuilder

Constructs a fluent builder for the CreateVpcAttachment operation.

Source§

impl Client

Source

pub fn delete_attachment(&self) -> DeleteAttachmentFluentBuilder

Constructs a fluent builder for the DeleteAttachment operation.

Source§

impl Client

Source

pub fn delete_connect_peer(&self) -> DeleteConnectPeerFluentBuilder

Constructs a fluent builder for the DeleteConnectPeer operation.

Source§

impl Client

Source

pub fn delete_connection(&self) -> DeleteConnectionFluentBuilder

Constructs a fluent builder for the DeleteConnection operation.

Source§

impl Client

Source

pub fn delete_core_network(&self) -> DeleteCoreNetworkFluentBuilder

Constructs a fluent builder for the DeleteCoreNetwork operation.

Source§

impl Client

Source

pub fn delete_core_network_policy_version( &self, ) -> DeleteCoreNetworkPolicyVersionFluentBuilder

Constructs a fluent builder for the DeleteCoreNetworkPolicyVersion operation.

Source§

impl Client

Source

pub fn delete_device(&self) -> DeleteDeviceFluentBuilder

Constructs a fluent builder for the DeleteDevice operation.

Source§

impl Client

Source

pub fn delete_global_network(&self) -> DeleteGlobalNetworkFluentBuilder

Constructs a fluent builder for the DeleteGlobalNetwork operation.

Source§

impl Client

Constructs a fluent builder for the DeleteLink operation.

Source§

impl Client

Source

pub fn delete_peering(&self) -> DeletePeeringFluentBuilder

Constructs a fluent builder for the DeletePeering operation.

Source§

impl Client

Source

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

Source§

impl Client

Source

pub fn delete_site(&self) -> DeleteSiteFluentBuilder

Constructs a fluent builder for the DeleteSite operation.

Source§

impl Client

Source

pub fn deregister_transit_gateway( &self, ) -> DeregisterTransitGatewayFluentBuilder

Constructs a fluent builder for the DeregisterTransitGateway operation.

Source§

impl Client

Source

pub fn describe_global_networks(&self) -> DescribeGlobalNetworksFluentBuilder

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

Source§

impl Client

Source

pub fn disassociate_connect_peer(&self) -> DisassociateConnectPeerFluentBuilder

Constructs a fluent builder for the DisassociateConnectPeer operation.

Source§

impl Client

Source

pub fn disassociate_customer_gateway( &self, ) -> DisassociateCustomerGatewayFluentBuilder

Constructs a fluent builder for the DisassociateCustomerGateway operation.

Source§

impl Client

Constructs a fluent builder for the DisassociateLink operation.

Source§

impl Client

Source

pub fn disassociate_transit_gateway_connect_peer( &self, ) -> DisassociateTransitGatewayConnectPeerFluentBuilder

Constructs a fluent builder for the DisassociateTransitGatewayConnectPeer operation.

Source§

impl Client

Source

pub fn execute_core_network_change_set( &self, ) -> ExecuteCoreNetworkChangeSetFluentBuilder

Constructs a fluent builder for the ExecuteCoreNetworkChangeSet operation.

Source§

impl Client

Source

pub fn get_connect_attachment(&self) -> GetConnectAttachmentFluentBuilder

Constructs a fluent builder for the GetConnectAttachment operation.

Source§

impl Client

Source

pub fn get_connect_peer(&self) -> GetConnectPeerFluentBuilder

Constructs a fluent builder for the GetConnectPeer operation.

Source§

impl Client

Source

pub fn get_connect_peer_associations( &self, ) -> GetConnectPeerAssociationsFluentBuilder

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

Source§

impl Client

Source

pub fn get_connections(&self) -> GetConnectionsFluentBuilder

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

Source§

impl Client

Source

pub fn get_core_network(&self) -> GetCoreNetworkFluentBuilder

Constructs a fluent builder for the GetCoreNetwork operation.

Source§

impl Client

Source

pub fn get_core_network_change_events( &self, ) -> GetCoreNetworkChangeEventsFluentBuilder

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

Source§

impl Client

Source

pub fn get_core_network_change_set( &self, ) -> GetCoreNetworkChangeSetFluentBuilder

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

Source§

impl Client

Source

pub fn get_core_network_policy(&self) -> GetCoreNetworkPolicyFluentBuilder

Constructs a fluent builder for the GetCoreNetworkPolicy operation.

Source§

impl Client

Source

pub fn get_customer_gateway_associations( &self, ) -> GetCustomerGatewayAssociationsFluentBuilder

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

Source§

impl Client

Source

pub fn get_devices(&self) -> GetDevicesFluentBuilder

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

Source§

impl Client

Source

pub fn get_direct_connect_gateway_attachment( &self, ) -> GetDirectConnectGatewayAttachmentFluentBuilder

Constructs a fluent builder for the GetDirectConnectGatewayAttachment operation.

Source§

impl Client

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

Source§

impl Client

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

Source§

impl Client

Source

pub fn get_network_resource_counts( &self, ) -> GetNetworkResourceCountsFluentBuilder

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

Source§

impl Client

Source

pub fn get_network_resource_relationships( &self, ) -> GetNetworkResourceRelationshipsFluentBuilder

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

Source§

impl Client

Source

pub fn get_network_resources(&self) -> GetNetworkResourcesFluentBuilder

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

Source§

impl Client

Source

pub fn get_network_routes(&self) -> GetNetworkRoutesFluentBuilder

Constructs a fluent builder for the GetNetworkRoutes operation.

Source§

impl Client

Source

pub fn get_network_telemetry(&self) -> GetNetworkTelemetryFluentBuilder

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

Source§

impl Client

Source

pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder

Constructs a fluent builder for the GetResourcePolicy operation.

Source§

impl Client

Source

pub fn get_route_analysis(&self) -> GetRouteAnalysisFluentBuilder

Constructs a fluent builder for the GetRouteAnalysis operation.

Source§

impl Client

Source

pub fn get_site_to_site_vpn_attachment( &self, ) -> GetSiteToSiteVpnAttachmentFluentBuilder

Constructs a fluent builder for the GetSiteToSiteVpnAttachment operation.

Source§

impl Client

Source

pub fn get_sites(&self) -> GetSitesFluentBuilder

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

Source§

impl Client

Source

pub fn get_transit_gateway_connect_peer_associations( &self, ) -> GetTransitGatewayConnectPeerAssociationsFluentBuilder

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

Source§

impl Client

Source

pub fn get_transit_gateway_peering( &self, ) -> GetTransitGatewayPeeringFluentBuilder

Constructs a fluent builder for the GetTransitGatewayPeering operation.

Source§

impl Client

Source

pub fn get_transit_gateway_registrations( &self, ) -> GetTransitGatewayRegistrationsFluentBuilder

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

Source§

impl Client

Source

pub fn get_transit_gateway_route_table_attachment( &self, ) -> GetTransitGatewayRouteTableAttachmentFluentBuilder

Constructs a fluent builder for the GetTransitGatewayRouteTableAttachment operation.

Source§

impl Client

Source

pub fn get_vpc_attachment(&self) -> GetVpcAttachmentFluentBuilder

Constructs a fluent builder for the GetVpcAttachment operation.

Source§

impl Client

Source

pub fn list_attachments(&self) -> ListAttachmentsFluentBuilder

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

Source§

impl Client

Source

pub fn list_connect_peers(&self) -> ListConnectPeersFluentBuilder

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

Source§

impl Client

Source

pub fn list_core_network_policy_versions( &self, ) -> ListCoreNetworkPolicyVersionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_core_networks(&self) -> ListCoreNetworksFluentBuilder

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

Source§

impl Client

Source

pub fn list_organization_service_access_status( &self, ) -> ListOrganizationServiceAccessStatusFluentBuilder

Constructs a fluent builder for the ListOrganizationServiceAccessStatus operation.

Source§

impl Client

Source

pub fn list_peerings(&self) -> ListPeeringsFluentBuilder

Constructs a fluent builder for the ListPeerings 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 put_core_network_policy(&self) -> PutCoreNetworkPolicyFluentBuilder

Constructs a fluent builder for the PutCoreNetworkPolicy operation.

Source§

impl Client

Source

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

Source§

impl Client

Source

pub fn register_transit_gateway(&self) -> RegisterTransitGatewayFluentBuilder

Constructs a fluent builder for the RegisterTransitGateway operation.

Source§

impl Client

Source

pub fn reject_attachment(&self) -> RejectAttachmentFluentBuilder

Constructs a fluent builder for the RejectAttachment operation.

Source§

impl Client

Source

pub fn restore_core_network_policy_version( &self, ) -> RestoreCoreNetworkPolicyVersionFluentBuilder

Constructs a fluent builder for the RestoreCoreNetworkPolicyVersion operation.

Source§

impl Client

Source

pub fn start_organization_service_access_update( &self, ) -> StartOrganizationServiceAccessUpdateFluentBuilder

Constructs a fluent builder for the StartOrganizationServiceAccessUpdate operation.

Source§

impl Client

Source

pub fn start_route_analysis(&self) -> StartRouteAnalysisFluentBuilder

Constructs a fluent builder for the StartRouteAnalysis 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 untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

Source§

impl Client

Source

pub fn update_connection(&self) -> UpdateConnectionFluentBuilder

Constructs a fluent builder for the UpdateConnection operation.

Source§

impl Client

Source

pub fn update_core_network(&self) -> UpdateCoreNetworkFluentBuilder

Constructs a fluent builder for the UpdateCoreNetwork operation.

Source§

impl Client

Source

pub fn update_device(&self) -> UpdateDeviceFluentBuilder

Constructs a fluent builder for the UpdateDevice operation.

Source§

impl Client

Source

pub fn update_direct_connect_gateway_attachment( &self, ) -> UpdateDirectConnectGatewayAttachmentFluentBuilder

Constructs a fluent builder for the UpdateDirectConnectGatewayAttachment operation.

Source§

impl Client

Source

pub fn update_global_network(&self) -> UpdateGlobalNetworkFluentBuilder

Constructs a fluent builder for the UpdateGlobalNetwork operation.

Source§

impl Client

Constructs a fluent builder for the UpdateLink operation.

Source§

impl Client

Source

pub fn update_network_resource_metadata( &self, ) -> UpdateNetworkResourceMetadataFluentBuilder

Constructs a fluent builder for the UpdateNetworkResourceMetadata operation.

Source§

impl Client

Source

pub fn update_site(&self) -> UpdateSiteFluentBuilder

Constructs a fluent builder for the UpdateSite operation.

Source§

impl Client

Source

pub fn update_vpc_attachment(&self) -> UpdateVpcAttachmentFluentBuilder

Constructs a fluent builder for the UpdateVpcAttachment 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 duplicate 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,