DescribeBrokerOutput

Struct DescribeBrokerOutput 

Source
#[non_exhaustive]
pub struct DescribeBrokerOutput {
Show 33 fields pub actions_required: Option<Vec<ActionRequired>>, pub authentication_strategy: Option<AuthenticationStrategy>, pub auto_minor_version_upgrade: Option<bool>, pub broker_arn: Option<String>, pub broker_id: Option<String>, pub broker_instances: Option<Vec<BrokerInstance>>, pub broker_name: Option<String>, pub broker_state: Option<BrokerState>, pub configurations: Option<Configurations>, pub created: Option<DateTime>, pub deployment_mode: Option<DeploymentMode>, pub encryption_options: Option<EncryptionOptions>, pub engine_type: Option<EngineType>, pub engine_version: Option<String>, pub host_instance_type: Option<String>, pub ldap_server_metadata: Option<LdapServerMetadataOutput>, pub logs: Option<LogsSummary>, pub maintenance_window_start_time: Option<WeeklyStartTime>, pub pending_authentication_strategy: Option<AuthenticationStrategy>, pub pending_engine_version: Option<String>, pub pending_host_instance_type: Option<String>, pub pending_ldap_server_metadata: Option<LdapServerMetadataOutput>, pub pending_security_groups: Option<Vec<String>>, pub publicly_accessible: Option<bool>, pub security_groups: Option<Vec<String>>, pub storage_type: Option<BrokerStorageType>, pub subnet_ids: Option<Vec<String>>, pub tags: Option<HashMap<String, String>>, pub users: Option<Vec<UserSummary>>, pub data_replication_metadata: Option<DataReplicationMetadataOutput>, pub data_replication_mode: Option<DataReplicationMode>, pub pending_data_replication_metadata: Option<DataReplicationMetadataOutput>, pub pending_data_replication_mode: Option<DataReplicationMode>, /* private fields */
}

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.
§actions_required: Option<Vec<ActionRequired>>

Actions required for a broker.

§authentication_strategy: Option<AuthenticationStrategy>

The authentication strategy used to secure the broker. The default is SIMPLE.

§auto_minor_version_upgrade: Option<bool>

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

§broker_arn: Option<String>

The broker's Amazon Resource Name (ARN).

§broker_id: Option<String>

The unique ID that Amazon MQ generates for the broker.

§broker_instances: Option<Vec<BrokerInstance>>

A list of information about allocated brokers.

§broker_name: Option<String>

The broker's name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

§broker_state: Option<BrokerState>

The broker's status.

§configurations: Option<Configurations>

The list of all revisions for the specified configuration.

§created: Option<DateTime>

The time when the broker was created.

§deployment_mode: Option<DeploymentMode>

The broker's deployment mode.

§encryption_options: Option<EncryptionOptions>

Encryption options for the broker.

§engine_type: Option<EngineType>

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

§engine_version: Option<String>

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

§host_instance_type: Option<String>

The broker's instance type.

§ldap_server_metadata: Option<LdapServerMetadataOutput>

The metadata of the LDAP server used to authenticate and authorize connections to the broker.

§logs: Option<LogsSummary>

The list of information about logs currently enabled and pending to be deployed for the specified broker.

§maintenance_window_start_time: Option<WeeklyStartTime>

The parameters that determine the WeeklyStartTime.

§pending_authentication_strategy: Option<AuthenticationStrategy>

The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

§pending_engine_version: Option<String>

The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

§pending_host_instance_type: Option<String>

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

§pending_ldap_server_metadata: Option<LdapServerMetadataOutput>

The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

§pending_security_groups: Option<Vec<String>>

The list of pending security groups to authorize connections to brokers.

§publicly_accessible: Option<bool>

Enables connections from applications outside of the VPC that hosts the broker's subnets.

§security_groups: Option<Vec<String>>

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

§storage_type: Option<BrokerStorageType>

The broker's storage type.

§subnet_ids: Option<Vec<String>>

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

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

The list of all tags associated with this broker.

§users: Option<Vec<UserSummary>>

The list of all broker usernames for the specified broker.

§data_replication_metadata: Option<DataReplicationMetadataOutput>

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

§data_replication_mode: Option<DataReplicationMode>

Describes whether this broker is a part of a data replication pair.

§pending_data_replication_metadata: Option<DataReplicationMetadataOutput>

The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

§pending_data_replication_mode: Option<DataReplicationMode>

Describes whether this broker will be a part of a data replication pair after reboot.

Implementations§

Source§

impl DescribeBrokerOutput

Source

pub fn actions_required(&self) -> &[ActionRequired]

Actions required for a broker.

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

Source

pub fn authentication_strategy(&self) -> Option<&AuthenticationStrategy>

The authentication strategy used to secure the broker. The default is SIMPLE.

Source

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

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Source

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

The broker's Amazon Resource Name (ARN).

Source

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

The unique ID that Amazon MQ generates for the broker.

Source

pub fn broker_instances(&self) -> &[BrokerInstance]

A list of information about allocated brokers.

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

Source

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

The broker's name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

Source

pub fn broker_state(&self) -> Option<&BrokerState>

The broker's status.

Source

pub fn configurations(&self) -> Option<&Configurations>

The list of all revisions for the specified configuration.

Source

pub fn created(&self) -> Option<&DateTime>

The time when the broker was created.

Source

pub fn deployment_mode(&self) -> Option<&DeploymentMode>

The broker's deployment mode.

Source

pub fn encryption_options(&self) -> Option<&EncryptionOptions>

Encryption options for the broker.

Source

pub fn engine_type(&self) -> Option<&EngineType>

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

Source

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

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

Source

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

The broker's instance type.

Source

pub fn ldap_server_metadata(&self) -> Option<&LdapServerMetadataOutput>

The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Source

pub fn logs(&self) -> Option<&LogsSummary>

The list of information about logs currently enabled and pending to be deployed for the specified broker.

Source

pub fn maintenance_window_start_time(&self) -> Option<&WeeklyStartTime>

The parameters that determine the WeeklyStartTime.

Source

pub fn pending_authentication_strategy(&self) -> Option<&AuthenticationStrategy>

The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

Source

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

The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

Source

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

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

Source

pub fn pending_ldap_server_metadata(&self) -> Option<&LdapServerMetadataOutput>

The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

Source

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

The list of pending security groups to authorize connections to brokers.

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

Source

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

Enables connections from applications outside of the VPC that hosts the broker's subnets.

Source

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

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

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

Source

pub fn storage_type(&self) -> Option<&BrokerStorageType>

The broker's storage type.

Source

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

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

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

Source

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

The list of all tags associated with this broker.

Source

pub fn users(&self) -> &[UserSummary]

The list of all broker usernames for the specified broker.

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

Source

pub fn data_replication_metadata( &self, ) -> Option<&DataReplicationMetadataOutput>

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

Source

pub fn data_replication_mode(&self) -> Option<&DataReplicationMode>

Describes whether this broker is a part of a data replication pair.

Source

pub fn pending_data_replication_metadata( &self, ) -> Option<&DataReplicationMetadataOutput>

The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

Source

pub fn pending_data_replication_mode(&self) -> Option<&DataReplicationMode>

Describes whether this broker will be a part of a data replication pair after reboot.

Source§

impl DescribeBrokerOutput

Source

pub fn builder() -> DescribeBrokerOutputBuilder

Creates a new builder-style object to manufacture DescribeBrokerOutput.

Trait Implementations§

Source§

impl Clone for DescribeBrokerOutput

Source§

fn clone(&self) -> DescribeBrokerOutput

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 DescribeBrokerOutput

Source§

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

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

impl PartialEq for DescribeBrokerOutput

Source§

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

Source§

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.
Source§

impl StructuralPartialEq for DescribeBrokerOutput

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,