#[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
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
impl AwsEcsTaskDefinitionContainerDefinitionsDetails
Sourcepub fn command(&self) -> &[String]
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()
.
Sourcepub fn depends_on(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails]
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()
.
Sourcepub fn disable_networking(&self) -> Option<bool>
pub fn disable_networking(&self) -> Option<bool>
Whether to disable networking within the container.
Sourcepub fn dns_search_domains(&self) -> &[String]
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()
.
Sourcepub fn dns_servers(&self) -> &[String]
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()
.
Sourcepub fn docker_labels(&self) -> Option<&HashMap<String, String>>
pub fn docker_labels(&self) -> Option<&HashMap<String, String>>
A key-value map of labels to add to the container.
Sourcepub fn docker_security_options(&self) -> &[String]
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()
.
Sourcepub fn entry_point(&self) -> &[String]
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()
.
Sourcepub fn environment(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails]
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()
.
Sourcepub fn environment_files(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails]
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()
.
Sourcepub fn essential(&self) -> Option<bool>
pub fn essential(&self) -> Option<bool>
Whether the container is essential. All tasks must have at least one essential container.
Sourcepub fn extra_hosts(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails]
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()
.
Sourcepub fn firelens_configuration(
&self,
) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails>
pub fn firelens_configuration( &self, ) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails>
The FireLens configuration for the container. Specifies and configures a log router for container logs.
Sourcepub fn health_check(
&self,
) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>
pub fn health_check( &self, ) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>
The container health check command and associated configuration parameters for the container.
Sourcepub fn interactive(&self) -> Option<bool>
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.
Sourcepub fn links(&self) -> &[String]
pub fn links(&self) -> &[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.
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()
.
Sourcepub fn linux_parameters(
&self,
) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails>
pub fn linux_parameters( &self, ) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails>
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
Sourcepub fn log_configuration(
&self,
) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails>
pub fn log_configuration( &self, ) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails>
The log configuration specification for the container.
Sourcepub fn memory(&self) -> Option<i32>
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.
Sourcepub fn memory_reservation(&self) -> Option<i32>
pub fn memory_reservation(&self) -> Option<i32>
The soft limit (in MiB) of memory to reserve for the container.
Sourcepub fn mount_points(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails]
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()
.
Sourcepub fn port_mappings(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails]
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()
.
Sourcepub fn privileged(&self) -> Option<bool>
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.
Sourcepub fn pseudo_terminal(&self) -> Option<bool>
pub fn pseudo_terminal(&self) -> Option<bool>
Whether to allocate a TTY to the container.
Sourcepub fn readonly_root_filesystem(&self) -> Option<bool>
pub fn readonly_root_filesystem(&self) -> Option<bool>
Whether the container is given read-only access to its root file system.
Sourcepub fn repository_credentials(
&self,
) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails>
pub fn repository_credentials( &self, ) -> Option<&AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails>
The private repository authentication credentials to use.
Sourcepub fn resource_requirements(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails]
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()
.
Sourcepub fn secrets(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails]
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()
.
Sourcepub fn start_timeout(&self) -> Option<i32>
pub fn start_timeout(&self) -> Option<i32>
The number of seconds to wait before giving up on resolving dependencies for a container.
Sourcepub fn stop_timeout(&self) -> Option<i32>
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.
Sourcepub fn system_controls(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails]
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()
.
Sourcepub fn ulimits(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails]
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()
.
Sourcepub fn user(&self) -> Option<&str>
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
Sourcepub fn volumes_from(
&self,
) -> &[AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails]
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()
.
Sourcepub fn working_directory(&self) -> Option<&str>
pub fn working_directory(&self) -> Option<&str>
The working directory in which to run commands inside the container.
Source§impl AwsEcsTaskDefinitionContainerDefinitionsDetails
impl AwsEcsTaskDefinitionContainerDefinitionsDetails
Sourcepub fn builder() -> AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder
pub fn builder() -> AwsEcsTaskDefinitionContainerDefinitionsDetailsBuilder
Creates a new builder-style object to manufacture AwsEcsTaskDefinitionContainerDefinitionsDetails
.
Trait Implementations§
Source§impl Clone for AwsEcsTaskDefinitionContainerDefinitionsDetails
impl Clone for AwsEcsTaskDefinitionContainerDefinitionsDetails
Source§fn clone(&self) -> AwsEcsTaskDefinitionContainerDefinitionsDetails
fn clone(&self) -> AwsEcsTaskDefinitionContainerDefinitionsDetails
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for AwsEcsTaskDefinitionContainerDefinitionsDetails
impl PartialEq for AwsEcsTaskDefinitionContainerDefinitionsDetails
Source§fn eq(&self, other: &AwsEcsTaskDefinitionContainerDefinitionsDetails) -> bool
fn eq(&self, other: &AwsEcsTaskDefinitionContainerDefinitionsDetails) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AwsEcsTaskDefinitionContainerDefinitionsDetails
Auto Trait Implementations§
impl Freeze for AwsEcsTaskDefinitionContainerDefinitionsDetails
impl RefUnwindSafe for AwsEcsTaskDefinitionContainerDefinitionsDetails
impl Send for AwsEcsTaskDefinitionContainerDefinitionsDetails
impl Sync for AwsEcsTaskDefinitionContainerDefinitionsDetails
impl Unpin for AwsEcsTaskDefinitionContainerDefinitionsDetails
impl UnwindSafe for AwsEcsTaskDefinitionContainerDefinitionsDetails
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);