Struct Client

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

Client for AWS Global Accelerator

Client for invoking operations on AWS Global Accelerator. Each operation on AWS Global Accelerator 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_globalaccelerator::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_globalaccelerator::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 AddCustomRoutingEndpoints operation has a Client::add_custom_routing_endpoints, 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.add_custom_routing_endpoints()
    .endpoint_group_arn("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 add_custom_routing_endpoints( &self, ) -> AddCustomRoutingEndpointsFluentBuilder

Constructs a fluent builder for the AddCustomRoutingEndpoints operation.

Source§

impl Client

Source

pub fn add_endpoints(&self) -> AddEndpointsFluentBuilder

Constructs a fluent builder for the AddEndpoints operation.

Source§

impl Client

Source

pub fn advertise_byoip_cidr(&self) -> AdvertiseByoipCidrFluentBuilder

Constructs a fluent builder for the AdvertiseByoipCidr operation.

Source§

impl Client

Source

pub fn allow_custom_routing_traffic( &self, ) -> AllowCustomRoutingTrafficFluentBuilder

Constructs a fluent builder for the AllowCustomRoutingTraffic operation.

Source§

impl Client

Source

pub fn create_accelerator(&self) -> CreateAcceleratorFluentBuilder

Constructs a fluent builder for the CreateAccelerator operation.

  • The fluent builder is configurable:
    • name(impl Into<String>) / set_name(Option<String>):
      required: true

      The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.


    • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
      required: false

      The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.


    • ip_addresses(impl Into<String>) / set_ip_addresses(Option<Vec::<String>>):
      required: false

      Optionally, if you’ve added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator’s static IPv4 address when you create an accelerator.

      After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

      You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

      Note that you can’t update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

      For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.


    • enabled(bool) / set_enabled(Option<bool>):
      required: false

      Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

      If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.


    • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
      required: true

      A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.


    • tags(Tag) / set_tags(Option<Vec::<Tag>>):
      required: false

      Create tags for an accelerator.

      For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.


  • On success, responds with CreateAcceleratorOutput with field(s):
  • On failure, responds with SdkError<CreateAcceleratorError>
Source§

impl Client

Source

pub fn create_cross_account_attachment( &self, ) -> CreateCrossAccountAttachmentFluentBuilder

Constructs a fluent builder for the CreateCrossAccountAttachment operation.

Source§

impl Client

Source

pub fn create_custom_routing_accelerator( &self, ) -> CreateCustomRoutingAcceleratorFluentBuilder

Constructs a fluent builder for the CreateCustomRoutingAccelerator operation.

Source§

impl Client

Source

pub fn create_custom_routing_endpoint_group( &self, ) -> CreateCustomRoutingEndpointGroupFluentBuilder

Constructs a fluent builder for the CreateCustomRoutingEndpointGroup operation.

Source§

impl Client

Source

pub fn create_custom_routing_listener( &self, ) -> CreateCustomRoutingListenerFluentBuilder

Constructs a fluent builder for the CreateCustomRoutingListener operation.

Source§

impl Client

Source

pub fn create_endpoint_group(&self) -> CreateEndpointGroupFluentBuilder

Constructs a fluent builder for the CreateEndpointGroup operation.

Source§

impl Client

Source

pub fn create_listener(&self) -> CreateListenerFluentBuilder

Constructs a fluent builder for the CreateListener operation.

  • The fluent builder is configurable:
    • accelerator_arn(impl Into<String>) / set_accelerator_arn(Option<String>):
      required: true

      The Amazon Resource Name (ARN) of your accelerator.


    • port_ranges(PortRange) / set_port_ranges(Option<Vec::<PortRange>>):
      required: true

      The list of port ranges to support for connections from clients to your accelerator.


    • protocol(Protocol) / set_protocol(Option<Protocol>):
      required: true

      The protocol for connections from clients to your accelerator.


    • client_affinity(ClientAffinity) / set_client_affinity(Option<ClientAffinity>):
      required: false

      Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

      Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the “five-tuple” (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

      If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the “two-tuple” (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

      The default value is NONE.


    • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
      required: true

      A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.


  • On success, responds with CreateListenerOutput with field(s):
  • On failure, responds with SdkError<CreateListenerError>
Source§

impl Client

Source

pub fn delete_accelerator(&self) -> DeleteAcceleratorFluentBuilder

Constructs a fluent builder for the DeleteAccelerator operation.

Source§

impl Client

Source

pub fn delete_cross_account_attachment( &self, ) -> DeleteCrossAccountAttachmentFluentBuilder

Constructs a fluent builder for the DeleteCrossAccountAttachment operation.

Source§

impl Client

Source

pub fn delete_custom_routing_accelerator( &self, ) -> DeleteCustomRoutingAcceleratorFluentBuilder

Constructs a fluent builder for the DeleteCustomRoutingAccelerator operation.

Source§

impl Client

Source

pub fn delete_custom_routing_endpoint_group( &self, ) -> DeleteCustomRoutingEndpointGroupFluentBuilder

Constructs a fluent builder for the DeleteCustomRoutingEndpointGroup operation.

Source§

impl Client

Source

pub fn delete_custom_routing_listener( &self, ) -> DeleteCustomRoutingListenerFluentBuilder

Constructs a fluent builder for the DeleteCustomRoutingListener operation.

Source§

impl Client

Source

pub fn delete_endpoint_group(&self) -> DeleteEndpointGroupFluentBuilder

Constructs a fluent builder for the DeleteEndpointGroup operation.

Source§

impl Client

Source

pub fn delete_listener(&self) -> DeleteListenerFluentBuilder

Constructs a fluent builder for the DeleteListener operation.

Source§

impl Client

Source

pub fn deny_custom_routing_traffic( &self, ) -> DenyCustomRoutingTrafficFluentBuilder

Constructs a fluent builder for the DenyCustomRoutingTraffic operation.

Source§

impl Client

Source

pub fn deprovision_byoip_cidr(&self) -> DeprovisionByoipCidrFluentBuilder

Constructs a fluent builder for the DeprovisionByoipCidr operation.

Source§

impl Client

Source

pub fn describe_accelerator(&self) -> DescribeAcceleratorFluentBuilder

Constructs a fluent builder for the DescribeAccelerator operation.

Source§

impl Client

Source

pub fn describe_accelerator_attributes( &self, ) -> DescribeAcceleratorAttributesFluentBuilder

Constructs a fluent builder for the DescribeAcceleratorAttributes operation.

Source§

impl Client

Source

pub fn describe_cross_account_attachment( &self, ) -> DescribeCrossAccountAttachmentFluentBuilder

Constructs a fluent builder for the DescribeCrossAccountAttachment operation.

Source§

impl Client

Source

pub fn describe_custom_routing_accelerator( &self, ) -> DescribeCustomRoutingAcceleratorFluentBuilder

Constructs a fluent builder for the DescribeCustomRoutingAccelerator operation.

Source§

impl Client

Source

pub fn describe_custom_routing_accelerator_attributes( &self, ) -> DescribeCustomRoutingAcceleratorAttributesFluentBuilder

Constructs a fluent builder for the DescribeCustomRoutingAcceleratorAttributes operation.

Source§

impl Client

Source

pub fn describe_custom_routing_endpoint_group( &self, ) -> DescribeCustomRoutingEndpointGroupFluentBuilder

Constructs a fluent builder for the DescribeCustomRoutingEndpointGroup operation.

Source§

impl Client

Source

pub fn describe_custom_routing_listener( &self, ) -> DescribeCustomRoutingListenerFluentBuilder

Constructs a fluent builder for the DescribeCustomRoutingListener operation.

Source§

impl Client

Source

pub fn describe_endpoint_group(&self) -> DescribeEndpointGroupFluentBuilder

Constructs a fluent builder for the DescribeEndpointGroup operation.

Source§

impl Client

Source

pub fn describe_listener(&self) -> DescribeListenerFluentBuilder

Constructs a fluent builder for the DescribeListener operation.

Source§

impl Client

Source

pub fn list_accelerators(&self) -> ListAcceleratorsFluentBuilder

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

Source§

impl Client

Source

pub fn list_byoip_cidrs(&self) -> ListByoipCidrsFluentBuilder

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

Source§

impl Client

Source

pub fn list_cross_account_attachments( &self, ) -> ListCrossAccountAttachmentsFluentBuilder

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

Source§

impl Client

Source

pub fn list_cross_account_resource_accounts( &self, ) -> ListCrossAccountResourceAccountsFluentBuilder

Constructs a fluent builder for the ListCrossAccountResourceAccounts operation.

Source§

impl Client

Source

pub fn list_cross_account_resources( &self, ) -> ListCrossAccountResourcesFluentBuilder

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

Source§

impl Client

Source

pub fn list_custom_routing_accelerators( &self, ) -> ListCustomRoutingAcceleratorsFluentBuilder

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

Source§

impl Client

Source

pub fn list_custom_routing_endpoint_groups( &self, ) -> ListCustomRoutingEndpointGroupsFluentBuilder

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

Source§

impl Client

Source

pub fn list_custom_routing_listeners( &self, ) -> ListCustomRoutingListenersFluentBuilder

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

Source§

impl Client

Source

pub fn list_custom_routing_port_mappings( &self, ) -> ListCustomRoutingPortMappingsFluentBuilder

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

Source§

impl Client

Source

pub fn list_custom_routing_port_mappings_by_destination( &self, ) -> ListCustomRoutingPortMappingsByDestinationFluentBuilder

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

Source§

impl Client

Source

pub fn list_endpoint_groups(&self) -> ListEndpointGroupsFluentBuilder

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

Source§

impl Client

Source

pub fn list_listeners(&self) -> ListListenersFluentBuilder

Constructs a fluent builder for the ListListeners 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 provision_byoip_cidr(&self) -> ProvisionByoipCidrFluentBuilder

Constructs a fluent builder for the ProvisionByoipCidr operation.

Source§

impl Client

Source

pub fn remove_custom_routing_endpoints( &self, ) -> RemoveCustomRoutingEndpointsFluentBuilder

Constructs a fluent builder for the RemoveCustomRoutingEndpoints operation.

Source§

impl Client

Source

pub fn remove_endpoints(&self) -> RemoveEndpointsFluentBuilder

Constructs a fluent builder for the RemoveEndpoints 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_accelerator(&self) -> UpdateAcceleratorFluentBuilder

Constructs a fluent builder for the UpdateAccelerator operation.

Source§

impl Client

Source

pub fn update_accelerator_attributes( &self, ) -> UpdateAcceleratorAttributesFluentBuilder

Constructs a fluent builder for the UpdateAcceleratorAttributes operation.

Source§

impl Client

Source

pub fn update_cross_account_attachment( &self, ) -> UpdateCrossAccountAttachmentFluentBuilder

Constructs a fluent builder for the UpdateCrossAccountAttachment operation.

Source§

impl Client

Source

pub fn update_custom_routing_accelerator( &self, ) -> UpdateCustomRoutingAcceleratorFluentBuilder

Constructs a fluent builder for the UpdateCustomRoutingAccelerator operation.

Source§

impl Client

Source

pub fn update_custom_routing_accelerator_attributes( &self, ) -> UpdateCustomRoutingAcceleratorAttributesFluentBuilder

Constructs a fluent builder for the UpdateCustomRoutingAcceleratorAttributes operation.

Source§

impl Client

Source

pub fn update_custom_routing_listener( &self, ) -> UpdateCustomRoutingListenerFluentBuilder

Constructs a fluent builder for the UpdateCustomRoutingListener operation.

Source§

impl Client

Source

pub fn update_endpoint_group(&self) -> UpdateEndpointGroupFluentBuilder

Constructs a fluent builder for the UpdateEndpointGroup operation.

Source§

impl Client

Source

pub fn update_listener(&self) -> UpdateListenerFluentBuilder

Constructs a fluent builder for the UpdateListener operation.

  • The fluent builder is configurable:
    • listener_arn(impl Into<String>) / set_listener_arn(Option<String>):
      required: true

      The Amazon Resource Name (ARN) of the listener to update.


    • port_ranges(PortRange) / set_port_ranges(Option<Vec::<PortRange>>):
      required: false

      The updated list of port ranges for the connections from clients to the accelerator.


    • protocol(Protocol) / set_protocol(Option<Protocol>):
      required: false

      The updated protocol for the connections from clients to the accelerator.


    • client_affinity(ClientAffinity) / set_client_affinity(Option<ClientAffinity>):
      required: false

      Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

      Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the “five-tuple” (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

      If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the “two-tuple” (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

      The default value is NONE.


  • On success, responds with UpdateListenerOutput with field(s):
  • On failure, responds with SdkError<UpdateListenerError>
Source§

impl Client

Source

pub fn withdraw_byoip_cidr(&self) -> WithdrawByoipCidrFluentBuilder

Constructs a fluent builder for the WithdrawByoipCidr 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§

const 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,