aws_sdk_opensearch::types::builders

Struct DomainStatusBuilder

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

A builder for DomainStatus.

Implementations§

Source§

impl DomainStatusBuilder

Source

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

Unique identifier for the domain.

This field is required.
Source

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

Unique identifier for the domain.

Source

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

Unique identifier for the domain.

Source

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

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

This field is required.
Source

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

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

Source

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

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

Source

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

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

This field is required.
Source

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

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

Source

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

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

Source

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

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

Source

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

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

Source

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

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

Source

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

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

Source

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

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

Source

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

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

Source

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

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

Source

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

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

Source

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

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

Source

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

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

Source

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

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

Source

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

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

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.

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

  • IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'

  • Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

Source

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

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

  • IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'

  • Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

Source

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

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

  • IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'

  • Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

Source

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

The dual stack hosted zone ID for the domain.

Source

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

The dual stack hosted zone ID for the domain.

Source

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

The dual stack hosted zone ID for the domain.

Source

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

The status of the domain configuration. True if OpenSearch 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 domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

Source

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

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

Source

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

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

Source

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

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

Source

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

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

Source

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

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

Source

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

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

Source

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

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

Source

pub fn cluster_config(self, input: ClusterConfig) -> Self

Container for the cluster configuration of the domain.

This field is required.
Source

pub fn set_cluster_config(self, input: Option<ClusterConfig>) -> Self

Container for the cluster configuration of the domain.

Source

pub fn get_cluster_config(&self) -> &Option<ClusterConfig>

Container for the cluster configuration of the domain.

Source

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

Container for EBS-based storage settings for the domain.

Source

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

Container for EBS-based storage settings for the domain.

Source

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

Container for EBS-based storage settings for the domain.

Source

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

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

Source

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

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

Source

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

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

Source

pub fn ip_address_type(self, input: IpAddressType) -> Self

The type of IP addresses supported by the endpoint for the domain.

Source

pub fn set_ip_address_type(self, input: Option<IpAddressType>) -> Self

The type of IP addresses supported by the endpoint for the domain.

Source

pub fn get_ip_address_type(&self) -> &Option<IpAddressType>

The type of IP addresses supported by the endpoint for the domain.

Source

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

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

Source

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

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

Source

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

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

Source

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

The VPC configuration for the domain.

Source

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

The VPC configuration for the domain.

Source

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

The VPC configuration for the domain.

Source

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

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

Source

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

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

Source

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

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

Source

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

Encryption at rest settings for the domain.

Source

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

Encryption at rest settings for the domain.

Source

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

Encryption at rest settings for the domain.

Source

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

Whether node-to-node encryption is enabled or disabled.

Source

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

Whether node-to-node encryption is enabled or disabled.

Source

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

Whether node-to-node encryption is enabled or disabled.

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.

Key-value pairs that specify advanced configuration options.

Source

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

Key-value pairs that specify advanced configuration options.

Source

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

Key-value pairs that specify advanced configuration options.

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 domain.

Source

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

Log publishing options for the domain.

Source

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

Log publishing options for the domain.

Source

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

The current status of the domain's service software.

Source

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

The current status of the domain's service software.

Source

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

The current status of the domain's service software.

Source

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

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

Source

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

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

Source

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

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

Source

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

Settings for fine-grained access control.

Source

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

Settings for fine-grained access control.

Source

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

Settings for fine-grained access control.

Source

pub fn identity_center_options(self, input: IdentityCenterOptions) -> Self

Configuration options for controlling IAM Identity Center integration within a domain.

Source

pub fn set_identity_center_options( self, input: Option<IdentityCenterOptions>, ) -> Self

Configuration options for controlling IAM Identity Center integration within a domain.

Source

pub fn get_identity_center_options(&self) -> &Option<IdentityCenterOptions>

Configuration options for controlling IAM Identity Center integration within a domain.

Source

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

Auto-Tune settings for the domain.

Source

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

Auto-Tune settings for the domain.

Source

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

Auto-Tune settings for the domain.

Source

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

Information about a configuration change happening on the domain.

Source

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

Information about a configuration change happening on the domain.

Source

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

Information about a configuration change happening on the domain.

Source

pub fn off_peak_window_options(self, input: OffPeakWindowOptions) -> Self

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

Source

pub fn set_off_peak_window_options( self, input: Option<OffPeakWindowOptions>, ) -> Self

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

Source

pub fn get_off_peak_window_options(&self) -> &Option<OffPeakWindowOptions>

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

Source

pub fn software_update_options(self, input: SoftwareUpdateOptions) -> Self

Service software update options for the domain.

Source

pub fn set_software_update_options( self, input: Option<SoftwareUpdateOptions>, ) -> Self

Service software update options for the domain.

Source

pub fn get_software_update_options(&self) -> &Option<SoftwareUpdateOptions>

Service software update options for the domain.

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 aiml_options(self, input: AimlOptionsOutput) -> Self

Container for parameters required to enable all machine learning features.

Source

pub fn set_aiml_options(self, input: Option<AimlOptionsOutput>) -> Self

Container for parameters required to enable all machine learning features.

Source

pub fn get_aiml_options(&self) -> &Option<AimlOptionsOutput>

Container for parameters required to enable all machine learning features.

Source

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

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

Trait Implementations§

Source§

impl Clone for DomainStatusBuilder

Source§

fn clone(&self) -> DomainStatusBuilder

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 DomainStatusBuilder

Source§

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

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

impl Default for DomainStatusBuilder

Source§

fn default() -> DomainStatusBuilder

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

impl PartialEq for DomainStatusBuilder

Source§

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

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,