aws_sdk_elasticsearch::types::builders

Struct ElasticsearchDomainStatusBuilder

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

A builder for ElasticsearchDomainStatus.

Implementations§

Source§

impl ElasticsearchDomainStatusBuilder

Source

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

The unique identifier for the specified Elasticsearch domain.

This field is required.
Source

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

The unique identifier for the specified Elasticsearch domain.

Source

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

The unique identifier for the specified Elasticsearch domain.

Source

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

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

This field is required.
Source

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

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Source

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

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Source

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

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

This field is required.
Source

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

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Source

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

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Source

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

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

Source

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

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

Source

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

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

Source

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

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

Source

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

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

Source

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

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

Source

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

The Elasticsearch domain endpoint that you use to submit index and search requests.

Source

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

The Elasticsearch domain endpoint that you use to submit index and search requests.

Source

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

The Elasticsearch domain endpoint that you use to submit index and search requests.

Source

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

Adds a key-value pair to endpoints.

To override the contents of this collection use set_endpoints.

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

Source

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

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

Source

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

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

Source

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

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

Source

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

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

Source

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

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

Source

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

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

Source

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

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

Source

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

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

Source

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

Source

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

Source

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

Source

pub fn elasticsearch_cluster_config( self, input: ElasticsearchClusterConfig, ) -> Self

The type and number of instances in the domain cluster.

This field is required.
Source

pub fn set_elasticsearch_cluster_config( self, input: Option<ElasticsearchClusterConfig>, ) -> Self

The type and number of instances in the domain cluster.

Source

pub fn get_elasticsearch_cluster_config( &self, ) -> &Option<ElasticsearchClusterConfig>

The type and number of instances in the domain cluster.

Source

pub fn ebs_options(self, input: EbsOptions) -> Self

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

Source

pub fn set_ebs_options(self, input: Option<EbsOptions>) -> Self

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

Source

pub fn get_ebs_options(&self) -> &Option<EbsOptions>

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

Source

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

IAM access policy as a JSON-formatted string.

Source

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

IAM access policy as a JSON-formatted string.

Source

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

IAM access policy as a JSON-formatted string.

Source

pub fn snapshot_options(self, input: SnapshotOptions) -> Self

Specifies the status of the SnapshotOptions

Source

pub fn set_snapshot_options(self, input: Option<SnapshotOptions>) -> Self

Specifies the status of the SnapshotOptions

Source

pub fn get_snapshot_options(&self) -> &Option<SnapshotOptions>

Specifies the status of the SnapshotOptions

Source

pub fn vpc_options(self, input: VpcDerivedInfo) -> Self

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

Source

pub fn set_vpc_options(self, input: Option<VpcDerivedInfo>) -> Self

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

Source

pub fn get_vpc_options(&self) -> &Option<VpcDerivedInfo>

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

Source

pub fn cognito_options(self, input: CognitoOptions) -> Self

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

Source

pub fn set_cognito_options(self, input: Option<CognitoOptions>) -> Self

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

Source

pub fn get_cognito_options(&self) -> &Option<CognitoOptions>

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

Source

pub fn encryption_at_rest_options(self, input: EncryptionAtRestOptions) -> Self

Specifies the status of the EncryptionAtRestOptions.

Source

pub fn set_encryption_at_rest_options( self, input: Option<EncryptionAtRestOptions>, ) -> Self

Specifies the status of the EncryptionAtRestOptions.

Source

pub fn get_encryption_at_rest_options(&self) -> &Option<EncryptionAtRestOptions>

Specifies the status of the EncryptionAtRestOptions.

Source

pub fn node_to_node_encryption_options( self, input: NodeToNodeEncryptionOptions, ) -> Self

Specifies the status of the NodeToNodeEncryptionOptions.

Source

pub fn set_node_to_node_encryption_options( self, input: Option<NodeToNodeEncryptionOptions>, ) -> Self

Specifies the status of the NodeToNodeEncryptionOptions.

Source

pub fn get_node_to_node_encryption_options( &self, ) -> &Option<NodeToNodeEncryptionOptions>

Specifies the status of the NodeToNodeEncryptionOptions.

Source

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

Adds a key-value pair to advanced_options.

To override the contents of this collection use set_advanced_options.

Specifies the status of the AdvancedOptions

Source

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

Specifies the status of the AdvancedOptions

Source

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

Specifies the status of the AdvancedOptions

Source

pub fn log_publishing_options(self, k: LogType, v: LogPublishingOption) -> Self

Adds a key-value pair to log_publishing_options.

To override the contents of this collection use set_log_publishing_options.

Log publishing options for the given domain.

Source

pub fn set_log_publishing_options( self, input: Option<HashMap<LogType, LogPublishingOption>>, ) -> Self

Log publishing options for the given domain.

Source

pub fn get_log_publishing_options( &self, ) -> &Option<HashMap<LogType, LogPublishingOption>>

Log publishing options for the given domain.

Source

pub fn service_software_options(self, input: ServiceSoftwareOptions) -> Self

The current status of the Elasticsearch domain's service software.

Source

pub fn set_service_software_options( self, input: Option<ServiceSoftwareOptions>, ) -> Self

The current status of the Elasticsearch domain's service software.

Source

pub fn get_service_software_options(&self) -> &Option<ServiceSoftwareOptions>

The current status of the Elasticsearch domain's service software.

Source

pub fn domain_endpoint_options(self, input: DomainEndpointOptions) -> Self

The current status of the Elasticsearch domain's endpoint options.

Source

pub fn set_domain_endpoint_options( self, input: Option<DomainEndpointOptions>, ) -> Self

The current status of the Elasticsearch domain's endpoint options.

Source

pub fn get_domain_endpoint_options(&self) -> &Option<DomainEndpointOptions>

The current status of the Elasticsearch domain's endpoint options.

Source

pub fn advanced_security_options(self, input: AdvancedSecurityOptions) -> Self

The current status of the Elasticsearch domain's advanced security options.

Source

pub fn set_advanced_security_options( self, input: Option<AdvancedSecurityOptions>, ) -> Self

The current status of the Elasticsearch domain's advanced security options.

Source

pub fn get_advanced_security_options(&self) -> &Option<AdvancedSecurityOptions>

The current status of the Elasticsearch domain's advanced security options.

Source

pub fn auto_tune_options(self, input: AutoTuneOptionsOutput) -> Self

The current status of the Elasticsearch domain's Auto-Tune options.

Source

pub fn set_auto_tune_options(self, input: Option<AutoTuneOptionsOutput>) -> Self

The current status of the Elasticsearch domain's Auto-Tune options.

Source

pub fn get_auto_tune_options(&self) -> &Option<AutoTuneOptionsOutput>

The current status of the Elasticsearch domain's Auto-Tune options.

Source

pub fn change_progress_details(self, input: ChangeProgressDetails) -> Self

Specifies change details of the domain configuration change.

Source

pub fn set_change_progress_details( self, input: Option<ChangeProgressDetails>, ) -> Self

Specifies change details of the domain configuration change.

Source

pub fn get_change_progress_details(&self) -> &Option<ChangeProgressDetails>

Specifies change details of the domain configuration change.

Source

pub fn domain_processing_status(self, input: DomainProcessingStatusType) -> Self

The status of any changes that are currently in progress for the domain.

Source

pub fn set_domain_processing_status( self, input: Option<DomainProcessingStatusType>, ) -> Self

The status of any changes that are currently in progress for the domain.

Source

pub fn get_domain_processing_status( &self, ) -> &Option<DomainProcessingStatusType>

The status of any changes that are currently in progress for the domain.

Source

pub fn modifying_properties(self, input: ModifyingProperties) -> Self

Appends an item to modifying_properties.

To override the contents of this collection use set_modifying_properties.

Information about the domain properties that are currently being modified.

Source

pub fn set_modifying_properties( self, input: Option<Vec<ModifyingProperties>>, ) -> Self

Information about the domain properties that are currently being modified.

Source

pub fn get_modifying_properties(&self) -> &Option<Vec<ModifyingProperties>>

Information about the domain properties that are currently being modified.

Source

pub fn build(self) -> Result<ElasticsearchDomainStatus, BuildError>

Consumes the builder and constructs a ElasticsearchDomainStatus. This method will fail if any of the following fields are not set:

Trait Implementations§

Source§

impl Clone for ElasticsearchDomainStatusBuilder

Source§

fn clone(&self) -> ElasticsearchDomainStatusBuilder

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 ElasticsearchDomainStatusBuilder

Source§

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

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

impl Default for ElasticsearchDomainStatusBuilder

Source§

fn default() -> ElasticsearchDomainStatusBuilder

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

impl PartialEq for ElasticsearchDomainStatusBuilder

Source§

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

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,