Client

aws_sdk_mediaconnect

Struct Client 

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

Client for AWS MediaConnect

Client for invoking operations on AWS MediaConnect. Each operation on AWS MediaConnect 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_mediaconnect::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_mediaconnect::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 AddBridgeOutputs operation has a Client::add_bridge_outputs, 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_bridge_outputs()
    .bridge_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.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

ⓘ
let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations§

Source§

impl Client

Source

pub fn add_bridge_outputs(&self) -> AddBridgeOutputsFluentBuilder

Constructs a fluent builder for the AddBridgeOutputs operation.

Source§

impl Client

Source

pub fn add_bridge_sources(&self) -> AddBridgeSourcesFluentBuilder

Constructs a fluent builder for the AddBridgeSources operation.

Source§

impl Client

Source

pub fn add_flow_media_streams(&self) -> AddFlowMediaStreamsFluentBuilder

Constructs a fluent builder for the AddFlowMediaStreams operation.

Source§

impl Client

Source

pub fn add_flow_outputs(&self) -> AddFlowOutputsFluentBuilder

Constructs a fluent builder for the AddFlowOutputs operation.

Source§

impl Client

Source

pub fn add_flow_sources(&self) -> AddFlowSourcesFluentBuilder

Constructs a fluent builder for the AddFlowSources operation.

Source§

impl Client

Source

pub fn add_flow_vpc_interfaces(&self) -> AddFlowVpcInterfacesFluentBuilder

Constructs a fluent builder for the AddFlowVpcInterfaces operation.

Source§

impl Client

Source

pub fn create_bridge(&self) -> CreateBridgeFluentBuilder

Constructs a fluent builder for the CreateBridge operation.

Source§

impl Client

Source

pub fn create_flow(&self) -> CreateFlowFluentBuilder

Constructs a fluent builder for the CreateFlow operation.

Source§

impl Client

Source

pub fn create_gateway(&self) -> CreateGatewayFluentBuilder

Constructs a fluent builder for the CreateGateway operation.

Source§

impl Client

Source

pub fn delete_bridge(&self) -> DeleteBridgeFluentBuilder

Constructs a fluent builder for the DeleteBridge operation.

Source§

impl Client

Source

pub fn delete_flow(&self) -> DeleteFlowFluentBuilder

Constructs a fluent builder for the DeleteFlow operation.

Source§

impl Client

Source

pub fn delete_gateway(&self) -> DeleteGatewayFluentBuilder

Constructs a fluent builder for the DeleteGateway operation.

Source§

impl Client

Source

pub fn deregister_gateway_instance( &self, ) -> DeregisterGatewayInstanceFluentBuilder

Constructs a fluent builder for the DeregisterGatewayInstance operation.

Source§

impl Client

Source

pub fn describe_bridge(&self) -> DescribeBridgeFluentBuilder

Constructs a fluent builder for the DescribeBridge operation.

Source§

impl Client

Source

pub fn describe_flow(&self) -> DescribeFlowFluentBuilder

Constructs a fluent builder for the DescribeFlow operation.

Source§

impl Client

Source

pub fn describe_flow_source_metadata( &self, ) -> DescribeFlowSourceMetadataFluentBuilder

Constructs a fluent builder for the DescribeFlowSourceMetadata operation.

Source§

impl Client

Source

pub fn describe_flow_source_thumbnail( &self, ) -> DescribeFlowSourceThumbnailFluentBuilder

Constructs a fluent builder for the DescribeFlowSourceThumbnail operation.

Source§

impl Client

Source

pub fn describe_gateway(&self) -> DescribeGatewayFluentBuilder

Constructs a fluent builder for the DescribeGateway operation.

Source§

impl Client

Source

pub fn describe_gateway_instance(&self) -> DescribeGatewayInstanceFluentBuilder

Constructs a fluent builder for the DescribeGatewayInstance operation.

Source§

impl Client

Source

pub fn describe_offering(&self) -> DescribeOfferingFluentBuilder

Constructs a fluent builder for the DescribeOffering operation.

Source§

impl Client

Source

pub fn describe_reservation(&self) -> DescribeReservationFluentBuilder

Constructs a fluent builder for the DescribeReservation operation.

Source§

impl Client

Source

pub fn grant_flow_entitlements(&self) -> GrantFlowEntitlementsFluentBuilder

Constructs a fluent builder for the GrantFlowEntitlements operation.

Source§

impl Client

Source

pub fn list_bridges(&self) -> ListBridgesFluentBuilder

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

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

      Filter the list results to display only the bridges associated with the selected ARN.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results to return per API request.

      For example, you submit a ListBridges request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

      The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.


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

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.


  • On success, responds with ListBridgesOutput with field(s):
    • bridges(Option<Vec::<ListedBridge>>):

      A list of bridge summaries.

    • next_token(Option<String>):

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.

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

impl Client

Source

pub fn list_entitlements(&self) -> ListEntitlementsFluentBuilder

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

  • The fluent builder is configurable:
    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results to return per API request.

      For example, you submit a ListEntitlements request with set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

      The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.


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

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.


  • On success, responds with ListEntitlementsOutput with field(s):
    • entitlements(Option<Vec::<ListedEntitlement>>):

      A list of entitlements that have been granted to you from other Amazon Web Services accounts.

    • next_token(Option<String>):

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.

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

impl Client

Source

pub fn list_flows(&self) -> ListFlowsFluentBuilder

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

  • The fluent builder is configurable:
    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results to return per API request.

      For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

      The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.


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

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.


  • On success, responds with ListFlowsOutput with field(s):
    • flows(Option<Vec::<ListedFlow>>):

      A list of flow summaries.

    • next_token(Option<String>):

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

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

impl Client

Source

pub fn list_gateway_instances(&self) -> ListGatewayInstancesFluentBuilder

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

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

      Filter the list results to display only the instances associated with the selected Gateway ARN.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results to return per API request.

      For example, you submit a ListInstances request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

      The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.


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

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListInstances request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken value.


  • On success, responds with ListGatewayInstancesOutput with field(s):
    • instances(Option<Vec::<ListedGatewayInstance>>):

      A list of instance summaries.

    • next_token(Option<String>):

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListInstances request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken value.

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

impl Client

Source

pub fn list_gateways(&self) -> ListGatewaysFluentBuilder

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

  • The fluent builder is configurable:
    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results to return per API request.

      For example, you submit a ListGateways request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

      The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.


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

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListGateways request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListGateways request a second time and specify the NextToken value.


  • On success, responds with ListGatewaysOutput with field(s):
    • gateways(Option<Vec::<ListedGateway>>):

      A list of gateway summaries.

    • next_token(Option<String>):

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListGateways request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListGateways request a second time and specify the NextToken value.

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

impl Client

Source

pub fn list_offerings(&self) -> ListOfferingsFluentBuilder

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

  • The fluent builder is configurable:
    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results to return per API request.

      For example, you submit a ListOfferings request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

      The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.


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

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.


  • On success, responds with ListOfferingsOutput with field(s):
    • next_token(Option<String>):

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.

    • offerings(Option<Vec::<Offering>>):

      A list of offerings that are available to this account in the current Amazon Web Services Region.

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

impl Client

Source

pub fn list_reservations(&self) -> ListReservationsFluentBuilder

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

  • The fluent builder is configurable:
    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results to return per API request.

      For example, you submit a ListReservations request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

      The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.


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

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.


  • On success, responds with ListReservationsOutput with field(s):
    • next_token(Option<String>):

      The token that identifies the batch of results that you want to see.

      For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value.

    • reservations(Option<Vec::<Reservation>>):

      A list of all reservations that have been purchased by this account in the current Amazon Web Services Region.

  • On failure, responds with SdkError<ListReservationsError>
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 purchase_offering(&self) -> PurchaseOfferingFluentBuilder

Constructs a fluent builder for the PurchaseOffering operation.

Source§

impl Client

Source

pub fn remove_bridge_output(&self) -> RemoveBridgeOutputFluentBuilder

Constructs a fluent builder for the RemoveBridgeOutput operation.

Source§

impl Client

Source

pub fn remove_bridge_source(&self) -> RemoveBridgeSourceFluentBuilder

Constructs a fluent builder for the RemoveBridgeSource operation.

Source§

impl Client

Source

pub fn remove_flow_media_stream(&self) -> RemoveFlowMediaStreamFluentBuilder

Constructs a fluent builder for the RemoveFlowMediaStream operation.

Source§

impl Client

Source

pub fn remove_flow_output(&self) -> RemoveFlowOutputFluentBuilder

Constructs a fluent builder for the RemoveFlowOutput operation.

Source§

impl Client

Source

pub fn remove_flow_source(&self) -> RemoveFlowSourceFluentBuilder

Constructs a fluent builder for the RemoveFlowSource operation.

Source§

impl Client

Source

pub fn remove_flow_vpc_interface(&self) -> RemoveFlowVpcInterfaceFluentBuilder

Constructs a fluent builder for the RemoveFlowVpcInterface operation.

Source§

impl Client

Source

pub fn revoke_flow_entitlement(&self) -> RevokeFlowEntitlementFluentBuilder

Constructs a fluent builder for the RevokeFlowEntitlement operation.

Source§

impl Client

Source

pub fn start_flow(&self) -> StartFlowFluentBuilder

Constructs a fluent builder for the StartFlow operation.

Source§

impl Client

Source

pub fn stop_flow(&self) -> StopFlowFluentBuilder

Constructs a fluent builder for the StopFlow 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_bridge(&self) -> UpdateBridgeFluentBuilder

Constructs a fluent builder for the UpdateBridge operation.

Source§

impl Client

Source

pub fn update_bridge_output(&self) -> UpdateBridgeOutputFluentBuilder

Constructs a fluent builder for the UpdateBridgeOutput operation.

Source§

impl Client

Source

pub fn update_bridge_source(&self) -> UpdateBridgeSourceFluentBuilder

Constructs a fluent builder for the UpdateBridgeSource operation.

Source§

impl Client

Source

pub fn update_bridge_state(&self) -> UpdateBridgeStateFluentBuilder

Constructs a fluent builder for the UpdateBridgeState operation.

Source§

impl Client

Source

pub fn update_flow(&self) -> UpdateFlowFluentBuilder

Constructs a fluent builder for the UpdateFlow operation.

Source§

impl Client

Source

pub fn update_flow_entitlement(&self) -> UpdateFlowEntitlementFluentBuilder

Constructs a fluent builder for the UpdateFlowEntitlement operation.

Source§

impl Client

Source

pub fn update_flow_media_stream(&self) -> UpdateFlowMediaStreamFluentBuilder

Constructs a fluent builder for the UpdateFlowMediaStream operation.

Source§

impl Client

Source

pub fn update_flow_output(&self) -> UpdateFlowOutputFluentBuilder

Constructs a fluent builder for the UpdateFlowOutput operation.

Source§

impl Client

Source

pub fn update_flow_source(&self) -> UpdateFlowSourceFluentBuilder

Constructs a fluent builder for the UpdateFlowSource operation.

Source§

impl Client

Source

pub fn update_gateway_instance(&self) -> UpdateGatewayInstanceFluentBuilder

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

impl Waiters for Client

Source§

fn wait_until_flow_active(&self) -> FlowActiveFluentBuilder

Wait until a flow is active
Source§

fn wait_until_flow_deleted(&self) -> FlowDeletedFluentBuilder

Wait until a flow is deleted
Source§

fn wait_until_flow_standby(&self) -> FlowStandbyFluentBuilder

Wait until a flow is in standby mode

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,