Struct AwsEcsServiceDetailsBuilder

Source
#[non_exhaustive]
pub struct AwsEcsServiceDetailsBuilder { /* private fields */ }
Expand description

A builder for AwsEcsServiceDetails.

Implementations§

Source§

impl AwsEcsServiceDetailsBuilder

Source

pub fn capacity_provider_strategy( self, input: AwsEcsServiceCapacityProviderStrategyDetails, ) -> Self

Appends an item to capacity_provider_strategy.

To override the contents of this collection use set_capacity_provider_strategy.

The capacity provider strategy that the service uses.

Source

pub fn set_capacity_provider_strategy( self, input: Option<Vec<AwsEcsServiceCapacityProviderStrategyDetails>>, ) -> Self

The capacity provider strategy that the service uses.

Source

pub fn get_capacity_provider_strategy( &self, ) -> &Option<Vec<AwsEcsServiceCapacityProviderStrategyDetails>>

The capacity provider strategy that the service uses.

Source

pub fn cluster(self, input: impl Into<String>) -> Self

The ARN of the cluster that hosts the service.

Source

pub fn set_cluster(self, input: Option<String>) -> Self

The ARN of the cluster that hosts the service.

Source

pub fn get_cluster(&self) -> &Option<String>

The ARN of the cluster that hosts the service.

Source

pub fn deployment_configuration( self, input: AwsEcsServiceDeploymentConfigurationDetails, ) -> Self

Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.

Source

pub fn set_deployment_configuration( self, input: Option<AwsEcsServiceDeploymentConfigurationDetails>, ) -> Self

Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.

Source

pub fn get_deployment_configuration( &self, ) -> &Option<AwsEcsServiceDeploymentConfigurationDetails>

Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.

Source

pub fn deployment_controller( self, input: AwsEcsServiceDeploymentControllerDetails, ) -> Self

Contains the deployment controller type that the service uses.

Source

pub fn set_deployment_controller( self, input: Option<AwsEcsServiceDeploymentControllerDetails>, ) -> Self

Contains the deployment controller type that the service uses.

Source

pub fn get_deployment_controller( &self, ) -> &Option<AwsEcsServiceDeploymentControllerDetails>

Contains the deployment controller type that the service uses.

Source

pub fn desired_count(self, input: i32) -> Self

The number of instantiations of the task definition to run on the service.

Source

pub fn set_desired_count(self, input: Option<i32>) -> Self

The number of instantiations of the task definition to run on the service.

Source

pub fn get_desired_count(&self) -> &Option<i32>

The number of instantiations of the task definition to run on the service.

Source

pub fn enable_ecs_managed_tags(self, input: bool) -> Self

Whether to enable Amazon ECS managed tags for the tasks in the service.

Source

pub fn set_enable_ecs_managed_tags(self, input: Option<bool>) -> Self

Whether to enable Amazon ECS managed tags for the tasks in the service.

Source

pub fn get_enable_ecs_managed_tags(&self) -> &Option<bool>

Whether to enable Amazon ECS managed tags for the tasks in the service.

Source

pub fn enable_execute_command(self, input: bool) -> Self

Whether the execute command functionality is enabled for the service.

Source

pub fn set_enable_execute_command(self, input: Option<bool>) -> Self

Whether the execute command functionality is enabled for the service.

Source

pub fn get_enable_execute_command(&self) -> &Option<bool>

Whether the execute command functionality is enabled for the service.

Source

pub fn health_check_grace_period_seconds(self, input: i32) -> Self

After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.

Source

pub fn set_health_check_grace_period_seconds(self, input: Option<i32>) -> Self

After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.

Source

pub fn get_health_check_grace_period_seconds(&self) -> &Option<i32>

After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.

Source

pub fn launch_type(self, input: impl Into<String>) -> Self

The launch type that the service uses.

Valid values: EC2 | FARGATE | EXTERNAL

Source

pub fn set_launch_type(self, input: Option<String>) -> Self

The launch type that the service uses.

Valid values: EC2 | FARGATE | EXTERNAL

Source

pub fn get_launch_type(&self) -> &Option<String>

The launch type that the service uses.

Valid values: EC2 | FARGATE | EXTERNAL

Source

pub fn load_balancers(self, input: AwsEcsServiceLoadBalancersDetails) -> Self

Appends an item to load_balancers.

To override the contents of this collection use set_load_balancers.

Information about the load balancers that the service uses.

Source

pub fn set_load_balancers( self, input: Option<Vec<AwsEcsServiceLoadBalancersDetails>>, ) -> Self

Information about the load balancers that the service uses.

Source

pub fn get_load_balancers( &self, ) -> &Option<Vec<AwsEcsServiceLoadBalancersDetails>>

Information about the load balancers that the service uses.

Source

pub fn name(self, input: impl Into<String>) -> Self

The name of the service.

Source

pub fn set_name(self, input: Option<String>) -> Self

The name of the service.

Source

pub fn get_name(&self) -> &Option<String>

The name of the service.

Source

pub fn network_configuration( self, input: AwsEcsServiceNetworkConfigurationDetails, ) -> Self

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

Source

pub fn set_network_configuration( self, input: Option<AwsEcsServiceNetworkConfigurationDetails>, ) -> Self

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

Source

pub fn get_network_configuration( &self, ) -> &Option<AwsEcsServiceNetworkConfigurationDetails>

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

Source

pub fn placement_constraints( self, input: AwsEcsServicePlacementConstraintsDetails, ) -> Self

Appends an item to placement_constraints.

To override the contents of this collection use set_placement_constraints.

The placement constraints for the tasks in the service.

Source

pub fn set_placement_constraints( self, input: Option<Vec<AwsEcsServicePlacementConstraintsDetails>>, ) -> Self

The placement constraints for the tasks in the service.

Source

pub fn get_placement_constraints( &self, ) -> &Option<Vec<AwsEcsServicePlacementConstraintsDetails>>

The placement constraints for the tasks in the service.

Source

pub fn placement_strategies( self, input: AwsEcsServicePlacementStrategiesDetails, ) -> Self

Appends an item to placement_strategies.

To override the contents of this collection use set_placement_strategies.

Information about how tasks for the service are placed.

Source

pub fn set_placement_strategies( self, input: Option<Vec<AwsEcsServicePlacementStrategiesDetails>>, ) -> Self

Information about how tasks for the service are placed.

Source

pub fn get_placement_strategies( &self, ) -> &Option<Vec<AwsEcsServicePlacementStrategiesDetails>>

Information about how tasks for the service are placed.

Source

pub fn platform_version(self, input: impl Into<String>) -> Self

The platform version on which to run the service. Only specified for tasks that are hosted on Fargate. If a platform version is not specified, the LATEST platform version is used by default.

Source

pub fn set_platform_version(self, input: Option<String>) -> Self

The platform version on which to run the service. Only specified for tasks that are hosted on Fargate. If a platform version is not specified, the LATEST platform version is used by default.

Source

pub fn get_platform_version(&self) -> &Option<String>

The platform version on which to run the service. Only specified for tasks that are hosted on Fargate. If a platform version is not specified, the LATEST platform version is used by default.

Source

pub fn propagate_tags(self, input: impl Into<String>) -> Self

Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated.

Valid values: TASK_DEFINITION | SERVICE

Source

pub fn set_propagate_tags(self, input: Option<String>) -> Self

Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated.

Valid values: TASK_DEFINITION | SERVICE

Source

pub fn get_propagate_tags(&self) -> &Option<String>

Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated.

Valid values: TASK_DEFINITION | SERVICE

Source

pub fn role(self, input: impl Into<String>) -> Self

The ARN of the IAM role that is associated with the service. The role allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Source

pub fn set_role(self, input: Option<String>) -> Self

The ARN of the IAM role that is associated with the service. The role allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Source

pub fn get_role(&self) -> &Option<String>

The ARN of the IAM role that is associated with the service. The role allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Source

pub fn scheduling_strategy(self, input: impl Into<String>) -> Self

The scheduling strategy to use for the service.

The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.

The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that don't meet the placement constraints.

Valid values: REPLICA | DAEMON

Source

pub fn set_scheduling_strategy(self, input: Option<String>) -> Self

The scheduling strategy to use for the service.

The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.

The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that don't meet the placement constraints.

Valid values: REPLICA | DAEMON

Source

pub fn get_scheduling_strategy(&self) -> &Option<String>

The scheduling strategy to use for the service.

The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.

The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that don't meet the placement constraints.

Valid values: REPLICA | DAEMON

Source

pub fn service_arn(self, input: impl Into<String>) -> Self

The ARN of the service.

Source

pub fn set_service_arn(self, input: Option<String>) -> Self

The ARN of the service.

Source

pub fn get_service_arn(&self) -> &Option<String>

The ARN of the service.

Source

pub fn service_name(self, input: impl Into<String>) -> Self

The name of the service.

The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.

Source

pub fn set_service_name(self, input: Option<String>) -> Self

The name of the service.

The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.

Source

pub fn get_service_name(&self) -> &Option<String>

The name of the service.

The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.

Source

pub fn service_registries( self, input: AwsEcsServiceServiceRegistriesDetails, ) -> Self

Appends an item to service_registries.

To override the contents of this collection use set_service_registries.

Information about the service discovery registries to assign to the service.

Source

pub fn set_service_registries( self, input: Option<Vec<AwsEcsServiceServiceRegistriesDetails>>, ) -> Self

Information about the service discovery registries to assign to the service.

Source

pub fn get_service_registries( &self, ) -> &Option<Vec<AwsEcsServiceServiceRegistriesDetails>>

Information about the service discovery registries to assign to the service.

Source

pub fn task_definition(self, input: impl Into<String>) -> Self

The task definition to use for tasks in the service.

Source

pub fn set_task_definition(self, input: Option<String>) -> Self

The task definition to use for tasks in the service.

Source

pub fn get_task_definition(&self) -> &Option<String>

The task definition to use for tasks in the service.

Source

pub fn build(self) -> AwsEcsServiceDetails

Consumes the builder and constructs a AwsEcsServiceDetails.

Trait Implementations§

Source§

impl Clone for AwsEcsServiceDetailsBuilder

Source§

fn clone(&self) -> AwsEcsServiceDetailsBuilder

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 AwsEcsServiceDetailsBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AwsEcsServiceDetailsBuilder

Source§

fn default() -> AwsEcsServiceDetailsBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for AwsEcsServiceDetailsBuilder

Source§

fn eq(&self, other: &AwsEcsServiceDetailsBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for AwsEcsServiceDetailsBuilder

Auto Trait Implementations§

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,