aws_sdk_appmesh::client

Struct Client

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

Client for AWS App Mesh

Client for invoking operations on AWS App Mesh. Each operation on AWS App Mesh 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_appmesh::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_appmesh::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 CreateGatewayRoute operation has a Client::create_gateway_route, 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.create_gateway_route()
    .gateway_route_name("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 create_gateway_route(&self) -> CreateGatewayRouteFluentBuilder

Constructs a fluent builder for the CreateGatewayRoute operation.

Source§

impl Client

Source

pub fn create_mesh(&self) -> CreateMeshFluentBuilder

Constructs a fluent builder for the CreateMesh operation.

Source§

impl Client

Source

pub fn create_route(&self) -> CreateRouteFluentBuilder

Constructs a fluent builder for the CreateRoute operation.

Source§

impl Client

Source

pub fn create_virtual_gateway(&self) -> CreateVirtualGatewayFluentBuilder

Constructs a fluent builder for the CreateVirtualGateway operation.

Source§

impl Client

Source

pub fn create_virtual_node(&self) -> CreateVirtualNodeFluentBuilder

Constructs a fluent builder for the CreateVirtualNode operation.

Source§

impl Client

Source

pub fn create_virtual_router(&self) -> CreateVirtualRouterFluentBuilder

Constructs a fluent builder for the CreateVirtualRouter operation.

Source§

impl Client

Source

pub fn create_virtual_service(&self) -> CreateVirtualServiceFluentBuilder

Constructs a fluent builder for the CreateVirtualService operation.

Source§

impl Client

Source

pub fn delete_gateway_route(&self) -> DeleteGatewayRouteFluentBuilder

Constructs a fluent builder for the DeleteGatewayRoute operation.

Source§

impl Client

Source

pub fn delete_mesh(&self) -> DeleteMeshFluentBuilder

Constructs a fluent builder for the DeleteMesh operation.

Source§

impl Client

Source

pub fn delete_route(&self) -> DeleteRouteFluentBuilder

Constructs a fluent builder for the DeleteRoute operation.

Source§

impl Client

Source

pub fn delete_virtual_gateway(&self) -> DeleteVirtualGatewayFluentBuilder

Constructs a fluent builder for the DeleteVirtualGateway operation.

Source§

impl Client

Source

pub fn delete_virtual_node(&self) -> DeleteVirtualNodeFluentBuilder

Constructs a fluent builder for the DeleteVirtualNode operation.

Source§

impl Client

Source

pub fn delete_virtual_router(&self) -> DeleteVirtualRouterFluentBuilder

Constructs a fluent builder for the DeleteVirtualRouter operation.

Source§

impl Client

Source

pub fn delete_virtual_service(&self) -> DeleteVirtualServiceFluentBuilder

Constructs a fluent builder for the DeleteVirtualService operation.

Source§

impl Client

Source

pub fn describe_gateway_route(&self) -> DescribeGatewayRouteFluentBuilder

Constructs a fluent builder for the DescribeGatewayRoute operation.

Source§

impl Client

Source

pub fn describe_mesh(&self) -> DescribeMeshFluentBuilder

Constructs a fluent builder for the DescribeMesh operation.

Source§

impl Client

Source

pub fn describe_route(&self) -> DescribeRouteFluentBuilder

Constructs a fluent builder for the DescribeRoute operation.

Source§

impl Client

Source

pub fn describe_virtual_gateway(&self) -> DescribeVirtualGatewayFluentBuilder

Constructs a fluent builder for the DescribeVirtualGateway operation.

Source§

impl Client

Source

pub fn describe_virtual_node(&self) -> DescribeVirtualNodeFluentBuilder

Constructs a fluent builder for the DescribeVirtualNode operation.

Source§

impl Client

Source

pub fn describe_virtual_router(&self) -> DescribeVirtualRouterFluentBuilder

Constructs a fluent builder for the DescribeVirtualRouter operation.

Source§

impl Client

Source

pub fn describe_virtual_service(&self) -> DescribeVirtualServiceFluentBuilder

Constructs a fluent builder for the DescribeVirtualService operation.

Source§

impl Client

Source

pub fn list_gateway_routes(&self) -> ListGatewayRoutesFluentBuilder

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

Source§

impl Client

Source

pub fn list_meshes(&self) -> ListMeshesFluentBuilder

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

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      The nextToken value returned from a previous paginated ListMeshes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.


    • limit(i32) / set_limit(Option<i32>):
      required: false

      The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable.


  • On success, responds with ListMeshesOutput with field(s):
    • meshes(Vec::<MeshRef>):

      The list of existing service meshes.

    • next_token(Option<String>):

      The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

  • On failure, responds with SdkError<ListMeshesError>
Source§

impl Client

Source

pub fn list_routes(&self) -> ListRoutesFluentBuilder

Constructs a fluent builder for the ListRoutes 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. This operation supports pagination; See into_paginator().

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

      The Amazon Resource Name (ARN) that identifies the resource to list the tags for.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      The nextToken value returned from a previous paginated ListTagsForResource request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.


    • limit(i32) / set_limit(Option<i32>):
      required: false

      The maximum number of tag results returned by ListTagsForResource in paginated output. When this parameter is used, ListTagsForResource returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListTagsForResource request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListTagsForResource returns up to 100 results and a nextToken value if applicable.


  • On success, responds with ListTagsForResourceOutput with field(s):
    • tags(Vec::<TagRef>):

      The tags for the resource.

    • next_token(Option<String>):

      The nextToken value to include in a future ListTagsForResource request. When the results of a ListTagsForResource request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

  • On failure, responds with SdkError<ListTagsForResourceError>
Source§

impl Client

Source

pub fn list_virtual_gateways(&self) -> ListVirtualGatewaysFluentBuilder

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

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

      The name of the service mesh to list virtual gateways in.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      The nextToken value returned from a previous paginated ListVirtualGateways request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.


    • limit(i32) / set_limit(Option<i32>):
      required: false

      The maximum number of results returned by ListVirtualGateways in paginated output. When you use this parameter, ListVirtualGateways returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualGateways request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListVirtualGateways returns up to 100 results and a nextToken value if applicable.


    • mesh_owner(impl Into<String>) / set_mesh_owner(Option<String>):
      required: false

      The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.


  • On success, responds with ListVirtualGatewaysOutput with field(s):
    • virtual_gateways(Vec::<VirtualGatewayRef>):

      The list of existing virtual gateways for the specified service mesh.

    • next_token(Option<String>):

      The nextToken value to include in a future ListVirtualGateways request. When the results of a ListVirtualGateways request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

  • On failure, responds with SdkError<ListVirtualGatewaysError>
Source§

impl Client

Source

pub fn list_virtual_nodes(&self) -> ListVirtualNodesFluentBuilder

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

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

      The name of the service mesh to list virtual nodes in.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      The nextToken value returned from a previous paginated ListVirtualNodes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.


    • limit(i32) / set_limit(Option<i32>):
      required: false

      The maximum number of results returned by ListVirtualNodes in paginated output. When you use this parameter, ListVirtualNodes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListVirtualNodes returns up to 100 results and a nextToken value if applicable.


    • mesh_owner(impl Into<String>) / set_mesh_owner(Option<String>):
      required: false

      The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.


  • On success, responds with ListVirtualNodesOutput with field(s):
    • virtual_nodes(Vec::<VirtualNodeRef>):

      The list of existing virtual nodes for the specified service mesh.

    • next_token(Option<String>):

      The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

  • On failure, responds with SdkError<ListVirtualNodesError>
Source§

impl Client

Source

pub fn list_virtual_routers(&self) -> ListVirtualRoutersFluentBuilder

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

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

      The name of the service mesh to list virtual routers in.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      The nextToken value returned from a previous paginated ListVirtualRouters request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.


    • limit(i32) / set_limit(Option<i32>):
      required: false

      The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.


    • mesh_owner(impl Into<String>) / set_mesh_owner(Option<String>):
      required: false

      The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.


  • On success, responds with ListVirtualRoutersOutput with field(s):
    • virtual_routers(Vec::<VirtualRouterRef>):

      The list of existing virtual routers for the specified service mesh.

    • next_token(Option<String>):

      The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

  • On failure, responds with SdkError<ListVirtualRoutersError>
Source§

impl Client

Source

pub fn list_virtual_services(&self) -> ListVirtualServicesFluentBuilder

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

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

      The name of the service mesh to list virtual services in.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      The nextToken value returned from a previous paginated ListVirtualServices request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.


    • limit(i32) / set_limit(Option<i32>):
      required: false

      The maximum number of results returned by ListVirtualServices in paginated output. When you use this parameter, ListVirtualServices returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualServices request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListVirtualServices returns up to 100 results and a nextToken value if applicable.


    • mesh_owner(impl Into<String>) / set_mesh_owner(Option<String>):
      required: false

      The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.


  • On success, responds with ListVirtualServicesOutput with field(s):
    • virtual_services(Vec::<VirtualServiceRef>):

      The list of existing virtual services for the specified service mesh.

    • next_token(Option<String>):

      The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

  • On failure, responds with SdkError<ListVirtualServicesError>
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_gateway_route(&self) -> UpdateGatewayRouteFluentBuilder

Constructs a fluent builder for the UpdateGatewayRoute operation.

Source§

impl Client

Source

pub fn update_mesh(&self) -> UpdateMeshFluentBuilder

Constructs a fluent builder for the UpdateMesh operation.

Source§

impl Client

Source

pub fn update_route(&self) -> UpdateRouteFluentBuilder

Constructs a fluent builder for the UpdateRoute operation.

Source§

impl Client

Source

pub fn update_virtual_gateway(&self) -> UpdateVirtualGatewayFluentBuilder

Constructs a fluent builder for the UpdateVirtualGateway operation.

Source§

impl Client

Source

pub fn update_virtual_node(&self) -> UpdateVirtualNodeFluentBuilder

Constructs a fluent builder for the UpdateVirtualNode operation.

Source§

impl Client

Source

pub fn update_virtual_router(&self) -> UpdateVirtualRouterFluentBuilder

Constructs a fluent builder for the UpdateVirtualRouter operation.

Source§

impl Client

Source

pub fn update_virtual_service(&self) -> UpdateVirtualServiceFluentBuilder

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