Struct AwsEcsTaskDefinitionContainerDefinitionsDetails

Source
#[non_exhaustive]
pub struct AwsEcsTaskDefinitionContainerDefinitionsDetails {
Show 39 fields pub command: Option<Vec<String>>, pub cpu: Option<i32>, pub depends_on: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails>>, pub disable_networking: Option<bool>, pub dns_search_domains: Option<Vec<String>>, pub dns_servers: Option<Vec<String>>, pub docker_labels: Option<HashMap<String, String>>, pub docker_security_options: Option<Vec<String>>, pub entry_point: Option<Vec<String>>, pub environment: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails>>, pub environment_files: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails>>, pub essential: Option<bool>, pub extra_hosts: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails>>, pub firelens_configuration: Option<AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails>, pub health_check: Option<AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>, pub hostname: Option<String>, pub image: Option<String>, pub interactive: Option<bool>, pub links: Option<Vec<String>>, pub linux_parameters: Option<AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails>, pub log_configuration: Option<AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails>, pub memory: Option<i32>, pub memory_reservation: Option<i32>, pub mount_points: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails>>, pub name: Option<String>, pub port_mappings: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails>>, pub privileged: Option<bool>, pub pseudo_terminal: Option<bool>, pub readonly_root_filesystem: Option<bool>, pub repository_credentials: Option<AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails>, pub resource_requirements: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails>>, pub secrets: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails>>, pub start_timeout: Option<i32>, pub stop_timeout: Option<i32>, pub system_controls: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails>>, pub ulimits: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails>>, pub user: Option<String>, pub volumes_from: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails>>, pub working_directory: Option<String>,
}
Expand description

A container definition that describes a container in the task.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§command: Option<Vec<String>>

The command that is passed to the container.

§cpu: Option<i32>

The number of CPU units reserved for the container.

§depends_on: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails>>

The dependencies that are defined for container startup and shutdown.

§disable_networking: Option<bool>

Whether to disable networking within the container.

§dns_search_domains: Option<Vec<String>>

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

§dns_servers: Option<Vec<String>>

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

§docker_labels: Option<HashMap<String, String>>

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

§docker_security_options: Option<Vec<String>>

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

§entry_point: Option<Vec<String>>

The entry point that is passed to the container.

§environment: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails>>

The environment variables to pass to a container.

§environment_files: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails>>

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

§essential: Option<bool>

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

§extra_hosts: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails>>

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

§firelens_configuration: Option<AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails>

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

§health_check: Option<AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>

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

§hostname: Option<String>

The hostname to use for the container.

§image: Option<String>

The image used to start the container.

§interactive: Option<bool>

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

§links: Option<Vec<String>>

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.

§linux_parameters: Option<AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails>

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

§log_configuration: Option<AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails>

The log configuration specification for the container.

§memory: 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.

§memory_reservation: Option<i32>

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

§mount_points: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails>>

The mount points for the data volumes in the container.

§name: Option<String>

The name of the container.

§port_mappings: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails>>

The list of port mappings for the container.

§privileged: Option<bool>

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

§pseudo_terminal: Option<bool>

Whether to allocate a TTY to the container.

§readonly_root_filesystem: Option<bool>

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

§repository_credentials: Option<AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails>

The private repository authentication credentials to use.

§resource_requirements: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails>>

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

§secrets: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails>>

The secrets to pass to the container.

§start_timeout: Option<i32>

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

§stop_timeout: Option<i32>

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

§system_controls: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails>>

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

§ulimits: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails>>

A list of ulimits to set in the container.

§user: 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

§volumes_from: Option<Vec<AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails>>

Data volumes to mount from another container.

§working_directory: Option<String>

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

Implementations§

Source§

impl AwsEcsTaskDefinitionContainerDefinitionsDetails

Source

pub fn command(&self) -> &[String]

The command that is passed to the container.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .command.is_none().

Source

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

The number of CPU units reserved for the container.

Source

pub fn depends_on( &self, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails]

The dependencies that are defined for container startup and shutdown.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .depends_on.is_none().

Source

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

Whether to disable networking within the container.

Source

pub fn dns_search_domains(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dns_search_domains.is_none().

Source

pub fn dns_servers(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dns_servers.is_none().

Source

pub fn 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) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .docker_security_options.is_none().

Source

pub fn entry_point(&self) -> &[String]

The entry point that is passed to the container.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .entry_point.is_none().

Source

pub fn environment( &self, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails]

The environment variables to pass to a container.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .environment.is_none().

Source

pub fn environment_files( &self, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .environment_files.is_none().

Source

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

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

Source

pub fn extra_hosts( &self, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .extra_hosts.is_none().

Source

pub fn 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, ) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>

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

Source

pub fn hostname(&self) -> Option<&str>

The hostname to use for the container.

Source

pub fn image(&self) -> Option<&str>

The image used to start the container.

Source

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

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

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .links.is_none().

Source

pub fn 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, ) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails>

The log configuration specification for the container.

Source

pub fn 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) -> Option<i32>

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

Source

pub fn mount_points( &self, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails]

The mount points for the data volumes in the container.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .mount_points.is_none().

Source

pub fn name(&self) -> Option<&str>

The name of the container.

Source

pub fn port_mappings( &self, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails]

The list of port mappings for the container.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .port_mappings.is_none().

Source

pub fn 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) -> Option<bool>

Whether to allocate a TTY to the container.

Source

pub fn 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, ) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails>

The private repository authentication credentials to use.

Source

pub fn resource_requirements( &self, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_requirements.is_none().

Source

pub fn secrets( &self, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails]

The secrets to pass to the container.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secrets.is_none().

Source

pub fn 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) -> 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, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .system_controls.is_none().

Source

pub fn ulimits( &self, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails]

A list of ulimits to set in the container.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ulimits.is_none().

Source

pub fn user(&self) -> Option<&str>

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, ) -> &[AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails]

Data volumes to mount from another container.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .volumes_from.is_none().

Source

pub fn working_directory(&self) -> Option<&str>

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

Source§

impl AwsEcsTaskDefinitionContainerDefinitionsDetails

Trait Implementations§

Source§

impl Clone for AwsEcsTaskDefinitionContainerDefinitionsDetails

Source§

fn clone(&self) -> AwsEcsTaskDefinitionContainerDefinitionsDetails

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AwsEcsTaskDefinitionContainerDefinitionsDetails

Source§

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

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

impl PartialEq for AwsEcsTaskDefinitionContainerDefinitionsDetails

Source§

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

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

const 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 AwsEcsTaskDefinitionContainerDefinitionsDetails

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,