AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder

aws_sdk_securityhub::types::builders

Struct AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder 

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

A builder for AwsEcsTaskDefinitionContainerDefinitionsDetails.

Implementations§

Source§

impl AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder

Source

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

Appends an item to command.

To override the contents of this collection use set_command.

The command that is passed to the container.

Source

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

The command that is passed to the container.

Source

pub fn get_command(&self) -> &Option<Vec<String>>

The command that is passed to the container.

Source

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

The number of CPU units reserved for the container.

Source

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

The number of CPU units reserved for the container.

Source

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

The number of CPU units reserved for the container.

Source

pub fn depends_on( self, input: AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails, ) -> Self

Appends an item to depends_on.

To override the contents of this collection use set_depends_on.

The dependencies that are defined for container startup and shutdown.

Source

pub fn set_depends_on( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails>>, ) -> Self

The dependencies that are defined for container startup and shutdown.

Source

pub fn get_depends_on( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails>>

The dependencies that are defined for container startup and shutdown.

Source

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

Whether to disable networking within the container.

Source

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

Whether to disable networking within the container.

Source

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

Whether to disable networking within the container.

Source

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

Appends an item to dns_search_domains.

To override the contents of this collection use set_dns_search_domains.

A list of DNS search domains that are presented to the container.

Source

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

A list of DNS search domains that are presented to the container.

Source

pub fn get_dns_search_domains(&self) -> &Option<Vec<String>>

A list of DNS search domains that are presented to the container.

Source

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

Appends an item to dns_servers.

To override the contents of this collection use set_dns_servers.

A list of DNS servers that are presented to the container.

Source

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

A list of DNS servers that are presented to the container.

Source

pub fn get_dns_servers(&self) -> &Option<Vec<String>>

A list of DNS servers that are presented to the container.

Source

pub fn docker_labels(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to docker_labels.

To override the contents of this collection use set_docker_labels.

A key-value map of labels to add to the container.

Source

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

A key-value map of labels to add to the container.

Source

pub fn get_docker_labels(&self) -> &Option<HashMap<String, String>>

A key-value map of labels to add to the container.

Source

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

Appends an item to docker_security_options.

To override the contents of this collection use set_docker_security_options.

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

Source

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

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

Source

pub fn get_docker_security_options(&self) -> &Option<Vec<String>>

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

Source

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

Appends an item to entry_point.

To override the contents of this collection use set_entry_point.

The entry point that is passed to the container.

Source

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

The entry point that is passed to the container.

Source

pub fn get_entry_point(&self) -> &Option<Vec<String>>

The entry point that is passed to the container.

Source

pub fn environment( self, input: AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails, ) -> Self

Appends an item to environment.

To override the contents of this collection use set_environment.

The environment variables to pass to a container.

Source

pub fn set_environment( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails>>, ) -> Self

The environment variables to pass to a container.

Source

pub fn get_environment( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails>>

The environment variables to pass to a container.

Source

pub fn environment_files( self, input: AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails, ) -> Self

Appends an item to environment_files.

To override the contents of this collection use set_environment_files.

A list of files containing the environment variables to pass to a container.

Source

pub fn set_environment_files( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails>>, ) -> Self

A list of files containing the environment variables to pass to a container.

Source

pub fn get_environment_files( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails>>

A list of files containing the environment variables to pass to a container.

Source

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

Whether the container is essential. All tasks must have at least one essential container.

Source

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

Whether the container is essential. All tasks must have at least one essential container.

Source

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

Whether the container is essential. All tasks must have at least one essential container.

Source

pub fn extra_hosts( self, input: AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails, ) -> Self

Appends an item to extra_hosts.

To override the contents of this collection use set_extra_hosts.

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

Source

pub fn set_extra_hosts( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails>>, ) -> Self

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

Source

pub fn get_extra_hosts( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails>>

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

Source

pub fn firelens_configuration( self, input: AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails, ) -> Self

The FireLens configuration for the container. Specifies and configures a log router for container logs.

Source

pub fn set_firelens_configuration( self, input: Option<AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails>, ) -> Self

The FireLens configuration for the container. Specifies and configures a log router for container logs.

Source

pub fn get_firelens_configuration( &self, ) -> &Option<AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails>

The FireLens configuration for the container. Specifies and configures a log router for container logs.

Source

pub fn health_check( self, input: AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails, ) -> Self

The container health check command and associated configuration parameters for the container.

Source

pub fn set_health_check( self, input: Option<AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>, ) -> Self

The container health check command and associated configuration parameters for the container.

Source

pub fn get_health_check( &self, ) -> &Option<AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>

The container health check command and associated configuration parameters for the container.

Source

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

The hostname to use for the container.

Source

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

The hostname to use for the container.

Source

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

The hostname to use for the container.

Source

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

The image used to start the container.

Source

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

The image used to start the container.

Source

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

The image used to start the container.

Source

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

If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.

Source

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

If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.

Source

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

If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.

Appends an item to links.

To override the contents of this collection use set_links.

A list of links for the container in the form container_name:alias . Allows containers to communicate with each other without the need for port mappings.

A list of links for the container in the form container_name:alias . Allows containers to communicate with each other without the need for port mappings.

A list of links for the container in the form container_name:alias . Allows containers to communicate with each other without the need for port mappings.

Source

pub fn linux_parameters( self, input: AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails, ) -> Self

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

Source

pub fn set_linux_parameters( self, input: Option<AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails>, ) -> Self

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

Source

pub fn get_linux_parameters( &self, ) -> &Option<AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails>

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

Source

pub fn log_configuration( self, input: AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails, ) -> Self

The log configuration specification for the container.

Source

pub fn set_log_configuration( self, input: Option<AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails>, ) -> Self

The log configuration specification for the container.

Source

pub fn get_log_configuration( &self, ) -> &Option<AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails>

The log configuration specification for the container.

Source

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

The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.

Source

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

The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.

Source

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

The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.

Source

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

The soft limit (in MiB) of memory to reserve for the container.

Source

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

The soft limit (in MiB) of memory to reserve for the container.

Source

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

The soft limit (in MiB) of memory to reserve for the container.

Source

pub fn mount_points( self, input: AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails, ) -> Self

Appends an item to mount_points.

To override the contents of this collection use set_mount_points.

The mount points for the data volumes in the container.

Source

pub fn set_mount_points( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails>>, ) -> Self

The mount points for the data volumes in the container.

Source

pub fn get_mount_points( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails>>

The mount points for the data volumes in the container.

Source

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

The name of the container.

Source

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

The name of the container.

Source

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

The name of the container.

Source

pub fn port_mappings( self, input: AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails, ) -> Self

Appends an item to port_mappings.

To override the contents of this collection use set_port_mappings.

The list of port mappings for the container.

Source

pub fn set_port_mappings( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails>>, ) -> Self

The list of port mappings for the container.

Source

pub fn get_port_mappings( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails>>

The list of port mappings for the container.

Source

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

Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.

Source

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

Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.

Source

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

Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.

Source

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

Whether to allocate a TTY to the container.

Source

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

Whether to allocate a TTY to the container.

Source

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

Whether to allocate a TTY to the container.

Source

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

Whether the container is given read-only access to its root file system.

Source

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

Whether the container is given read-only access to its root file system.

Source

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

Whether the container is given read-only access to its root file system.

Source

pub fn repository_credentials( self, input: AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails, ) -> Self

The private repository authentication credentials to use.

Source

pub fn set_repository_credentials( self, input: Option<AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails>, ) -> Self

The private repository authentication credentials to use.

Source

pub fn get_repository_credentials( &self, ) -> &Option<AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails>

The private repository authentication credentials to use.

Source

pub fn resource_requirements( self, input: AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails, ) -> Self

Appends an item to resource_requirements.

To override the contents of this collection use set_resource_requirements.

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Source

pub fn set_resource_requirements( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails>>, ) -> Self

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Source

pub fn get_resource_requirements( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails>>

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Source

pub fn secrets( self, input: AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails, ) -> Self

Appends an item to secrets.

To override the contents of this collection use set_secrets.

The secrets to pass to the container.

Source

pub fn set_secrets( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails>>, ) -> Self

The secrets to pass to the container.

Source

pub fn get_secrets( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails>>

The secrets to pass to the container.

Source

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

The number of seconds to wait before giving up on resolving dependencies for a container.

Source

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

The number of seconds to wait before giving up on resolving dependencies for a container.

Source

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

The number of seconds to wait before giving up on resolving dependencies for a container.

Source

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

The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.

Source

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

The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.

Source

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

The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.

Source

pub fn system_controls( self, input: AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails, ) -> Self

Appends an item to system_controls.

To override the contents of this collection use set_system_controls.

A list of namespaced kernel parameters to set in the container.

Source

pub fn set_system_controls( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails>>, ) -> Self

A list of namespaced kernel parameters to set in the container.

Source

pub fn get_system_controls( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails>>

A list of namespaced kernel parameters to set in the container.

Source

pub fn ulimits( self, input: AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails, ) -> Self

Appends an item to ulimits.

To override the contents of this collection use set_ulimits.

A list of ulimits to set in the container.

Source

pub fn set_ulimits( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails>>, ) -> Self

A list of ulimits to set in the container.

Source

pub fn get_ulimits( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails>>

A list of ulimits to set in the container.

Source

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

The user to use inside the container.

The value can use one of the following formats.

  • user

  • user : group

  • uid

  • uid : gid

  • user : gid

  • uid : group

Source

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

The user to use inside the container.

The value can use one of the following formats.

  • user

  • user : group

  • uid

  • uid : gid

  • user : gid

  • uid : group

Source

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

The user to use inside the container.

The value can use one of the following formats.

  • user

  • user : group

  • uid

  • uid : gid

  • user : gid

  • uid : group

Source

pub fn volumes_from( self, input: AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails, ) -> Self

Appends an item to volumes_from.

To override the contents of this collection use set_volumes_from.

Data volumes to mount from another container.

Source

pub fn set_volumes_from( self, input: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails>>, ) -> Self

Data volumes to mount from another container.

Source

pub fn get_volumes_from( &self, ) -> &Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails>>

Data volumes to mount from another container.

Source

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

The working directory in which to run commands inside the container.

Source

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

The working directory in which to run commands inside the container.

Source

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

The working directory in which to run commands inside the container.

Source

pub fn build(self) -> AwsEcsTaskDefinitionContainerDefinitionsDetails

Consumes the builder and constructs a AwsEcsTaskDefinitionContainerDefinitionsDetails.

Trait Implementations§

Source§

impl Clone for AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder

Source§

fn clone(&self) -> AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder

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 AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder

Source§

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

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

impl Default for AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder

Source§

fn default() -> AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder

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

impl PartialEq for AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder

Source§

fn eq( &self, other: &AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder, ) -> 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 AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder

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,