Struct Client

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

Client for Application Migration Service

Client for invoking operations on Application Migration Service. Each operation on Application Migration Service 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_mgn::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_mgn::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 ArchiveApplication operation has a Client::archive_application, 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.archive_application()
    .application_id("example")
    .send()
    .await;

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

Implementations§

Source§

impl Client

Source

pub fn archive_application(&self) -> ArchiveApplicationFluentBuilder

Constructs a fluent builder for the ArchiveApplication operation.

Source§

impl Client

Source

pub fn archive_wave(&self) -> ArchiveWaveFluentBuilder

Constructs a fluent builder for the ArchiveWave operation.

Source§

impl Client

Source

pub fn associate_applications(&self) -> AssociateApplicationsFluentBuilder

Constructs a fluent builder for the AssociateApplications operation.

Source§

impl Client

Source

pub fn associate_source_servers(&self) -> AssociateSourceServersFluentBuilder

Constructs a fluent builder for the AssociateSourceServers operation.

Source§

impl Client

Source

pub fn change_server_life_cycle_state( &self, ) -> ChangeServerLifeCycleStateFluentBuilder

Constructs a fluent builder for the ChangeServerLifeCycleState operation.

Source§

impl Client

Source

pub fn create_application(&self) -> CreateApplicationFluentBuilder

Constructs a fluent builder for the CreateApplication operation.

Source§

impl Client

Source

pub fn create_connector(&self) -> CreateConnectorFluentBuilder

Constructs a fluent builder for the CreateConnector operation.

Source§

impl Client

Source

pub fn create_launch_configuration_template( &self, ) -> CreateLaunchConfigurationTemplateFluentBuilder

Constructs a fluent builder for the CreateLaunchConfigurationTemplate operation.

Source§

impl Client

Source

pub fn create_replication_configuration_template( &self, ) -> CreateReplicationConfigurationTemplateFluentBuilder

Constructs a fluent builder for the CreateReplicationConfigurationTemplate operation.

Source§

impl Client

Source

pub fn create_wave(&self) -> CreateWaveFluentBuilder

Constructs a fluent builder for the CreateWave operation.

Source§

impl Client

Source

pub fn delete_application(&self) -> DeleteApplicationFluentBuilder

Constructs a fluent builder for the DeleteApplication operation.

Source§

impl Client

Source

pub fn delete_connector(&self) -> DeleteConnectorFluentBuilder

Constructs a fluent builder for the DeleteConnector operation.

Source§

impl Client

Source

pub fn delete_job(&self) -> DeleteJobFluentBuilder

Constructs a fluent builder for the DeleteJob operation.

Source§

impl Client

Source§

impl Client

Source

pub fn delete_replication_configuration_template( &self, ) -> DeleteReplicationConfigurationTemplateFluentBuilder

Constructs a fluent builder for the DeleteReplicationConfigurationTemplate operation.

Source§

impl Client

Source

pub fn delete_source_server(&self) -> DeleteSourceServerFluentBuilder

Constructs a fluent builder for the DeleteSourceServer operation.

Source§

impl Client

Source

pub fn delete_vcenter_client(&self) -> DeleteVcenterClientFluentBuilder

Constructs a fluent builder for the DeleteVcenterClient operation.

Source§

impl Client

Source

pub fn delete_wave(&self) -> DeleteWaveFluentBuilder

Constructs a fluent builder for the DeleteWave operation.

Source§

impl Client

Source

pub fn describe_job_log_items(&self) -> DescribeJobLogItemsFluentBuilder

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

Source§

impl Client

Source

pub fn describe_jobs(&self) -> DescribeJobsFluentBuilder

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

Source§

impl Client

Source

pub fn describe_launch_configuration_templates( &self, ) -> DescribeLaunchConfigurationTemplatesFluentBuilder

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

Source§

impl Client

Source

pub fn describe_replication_configuration_templates( &self, ) -> DescribeReplicationConfigurationTemplatesFluentBuilder

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

Source§

impl Client

Source

pub fn describe_source_servers(&self) -> DescribeSourceServersFluentBuilder

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

Source§

impl Client

Source

pub fn describe_vcenter_clients(&self) -> DescribeVcenterClientsFluentBuilder

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

Source§

impl Client

Source

pub fn disassociate_applications(&self) -> DisassociateApplicationsFluentBuilder

Constructs a fluent builder for the DisassociateApplications operation.

Source§

impl Client

Source

pub fn disassociate_source_servers( &self, ) -> DisassociateSourceServersFluentBuilder

Constructs a fluent builder for the DisassociateSourceServers operation.

Source§

impl Client

Source

pub fn disconnect_from_service(&self) -> DisconnectFromServiceFluentBuilder

Constructs a fluent builder for the DisconnectFromService operation.

Source§

impl Client

Source

pub fn finalize_cutover(&self) -> FinalizeCutoverFluentBuilder

Constructs a fluent builder for the FinalizeCutover operation.

Source§

impl Client

Source

pub fn get_launch_configuration(&self) -> GetLaunchConfigurationFluentBuilder

Constructs a fluent builder for the GetLaunchConfiguration operation.

Source§

impl Client

Source

pub fn get_replication_configuration( &self, ) -> GetReplicationConfigurationFluentBuilder

Constructs a fluent builder for the GetReplicationConfiguration operation.

Source§

impl Client

Source

pub fn initialize_service(&self) -> InitializeServiceFluentBuilder

Constructs a fluent builder for the InitializeService operation.

Source§

impl Client

Source

pub fn list_applications(&self) -> ListApplicationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_connectors(&self) -> ListConnectorsFluentBuilder

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

Source§

impl Client

Source

pub fn list_export_errors(&self) -> ListExportErrorsFluentBuilder

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

Source§

impl Client

Source

pub fn list_exports(&self) -> ListExportsFluentBuilder

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

Source§

impl Client

Source

pub fn list_import_errors(&self) -> ListImportErrorsFluentBuilder

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

Source§

impl Client

Source

pub fn list_imports(&self) -> ListImportsFluentBuilder

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

Source§

impl Client

Source

pub fn list_managed_accounts(&self) -> ListManagedAccountsFluentBuilder

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

Source§

impl Client

Source

pub fn list_source_server_actions(&self) -> ListSourceServerActionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

Source§

impl Client

Source

pub fn list_template_actions(&self) -> ListTemplateActionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_waves(&self) -> ListWavesFluentBuilder

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

Source§

impl Client

Source

pub fn mark_as_archived(&self) -> MarkAsArchivedFluentBuilder

Constructs a fluent builder for the MarkAsArchived operation.

Source§

impl Client

Source

pub fn pause_replication(&self) -> PauseReplicationFluentBuilder

Constructs a fluent builder for the PauseReplication operation.

Source§

impl Client

Source

pub fn put_source_server_action(&self) -> PutSourceServerActionFluentBuilder

Constructs a fluent builder for the PutSourceServerAction operation.

Source§

impl Client

Source

pub fn put_template_action(&self) -> PutTemplateActionFluentBuilder

Constructs a fluent builder for the PutTemplateAction operation.

Source§

impl Client

Source

pub fn remove_source_server_action( &self, ) -> RemoveSourceServerActionFluentBuilder

Constructs a fluent builder for the RemoveSourceServerAction operation.

Source§

impl Client

Source

pub fn remove_template_action(&self) -> RemoveTemplateActionFluentBuilder

Constructs a fluent builder for the RemoveTemplateAction operation.

Source§

impl Client

Source

pub fn resume_replication(&self) -> ResumeReplicationFluentBuilder

Constructs a fluent builder for the ResumeReplication operation.

Source§

impl Client

Source

pub fn retry_data_replication(&self) -> RetryDataReplicationFluentBuilder

Constructs a fluent builder for the RetryDataReplication operation.

Source§

impl Client

Source

pub fn start_cutover(&self) -> StartCutoverFluentBuilder

Constructs a fluent builder for the StartCutover operation.

Source§

impl Client

Source

pub fn start_export(&self) -> StartExportFluentBuilder

Constructs a fluent builder for the StartExport operation.

Source§

impl Client

Source

pub fn start_import(&self) -> StartImportFluentBuilder

Constructs a fluent builder for the StartImport operation.

Source§

impl Client

Source

pub fn start_replication(&self) -> StartReplicationFluentBuilder

Constructs a fluent builder for the StartReplication operation.

Source§

impl Client

Source

pub fn start_test(&self) -> StartTestFluentBuilder

Constructs a fluent builder for the StartTest operation.

Source§

impl Client

Source

pub fn stop_replication(&self) -> StopReplicationFluentBuilder

Constructs a fluent builder for the StopReplication 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 terminate_target_instances( &self, ) -> TerminateTargetInstancesFluentBuilder

Constructs a fluent builder for the TerminateTargetInstances operation.

Source§

impl Client

Source

pub fn unarchive_application(&self) -> UnarchiveApplicationFluentBuilder

Constructs a fluent builder for the UnarchiveApplication operation.

Source§

impl Client

Source

pub fn unarchive_wave(&self) -> UnarchiveWaveFluentBuilder

Constructs a fluent builder for the UnarchiveWave 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_application(&self) -> UpdateApplicationFluentBuilder

Constructs a fluent builder for the UpdateApplication operation.

Source§

impl Client

Source

pub fn update_connector(&self) -> UpdateConnectorFluentBuilder

Constructs a fluent builder for the UpdateConnector operation.

Source§

impl Client

Source

pub fn update_launch_configuration( &self, ) -> UpdateLaunchConfigurationFluentBuilder

Constructs a fluent builder for the UpdateLaunchConfiguration operation.

Source§

impl Client

Source

pub fn update_launch_configuration_template( &self, ) -> UpdateLaunchConfigurationTemplateFluentBuilder

Constructs a fluent builder for the UpdateLaunchConfigurationTemplate operation.

Source§

impl Client

Source

pub fn update_replication_configuration( &self, ) -> UpdateReplicationConfigurationFluentBuilder

Constructs a fluent builder for the UpdateReplicationConfiguration operation.

Source§

impl Client

Source

pub fn update_replication_configuration_template( &self, ) -> UpdateReplicationConfigurationTemplateFluentBuilder

Constructs a fluent builder for the UpdateReplicationConfigurationTemplate operation.

Source§

impl Client

Source

pub fn update_source_server(&self) -> UpdateSourceServerFluentBuilder

Constructs a fluent builder for the UpdateSourceServer operation.

Source§

impl Client

Source

pub fn update_source_server_replication_type( &self, ) -> UpdateSourceServerReplicationTypeFluentBuilder

Constructs a fluent builder for the UpdateSourceServerReplicationType operation.

Source§

impl Client

Source

pub fn update_wave(&self) -> UpdateWaveFluentBuilder

Constructs a fluent builder for the UpdateWave operation.

Source§

impl Client

Source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

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

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

Source

pub fn config(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

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

Creates a new client from an SDK Config.

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

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

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

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

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

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

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

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

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

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

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

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

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

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

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

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

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

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

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

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

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

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

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

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

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

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

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

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

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

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

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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