aws_sdk_opensearch::operation::update_domain_config::builders

Struct UpdateDomainConfigFluentBuilder

Source 
pub struct UpdateDomainConfigFluentBuilder { /* private fields */ }
Expand description

Fluent builder constructing a request to UpdateDomainConfig.

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

Implementations§

Source§

impl UpdateDomainConfigFluentBuilder

Source

pub fn as_input(&self) -> &UpdateDomainConfigInputBuilder

Access the UpdateDomainConfig as a reference.

Source

pub async fn send( self, ) -> Result<UpdateDomainConfigOutput, SdkError<UpdateDomainConfigError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

Source

pub fn customize( self, ) -> CustomizableOperation<UpdateDomainConfigOutput, UpdateDomainConfigError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

Source

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

The name of the domain that you're updating.

Source

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

The name of the domain that you're updating.

Source

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

The name of the domain that you're updating.

Source

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

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

Source

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

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

Source

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

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

Source

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

The type and size of the EBS volume to attach to instances in the domain.

Source

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

The type and size of the EBS volume to attach to instances in the domain.

Source

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

The type and size of the EBS volume to attach to instances in the domain.

Source

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

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

Source

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

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

Source

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

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

Source

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

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

Source

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

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

Source

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

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

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 advanced_options( self, k: impl Into<String>, v: impl Into<String>, ) -> Self

Adds a key-value pair to AdvancedOptions.

To override the contents of this collection use set_advanced_options.

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

  • "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

  • "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

  • "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

For more information, see Advanced cluster parameters.

Source

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

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

  • "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

  • "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

  • "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

For more information, see Advanced cluster parameters.

Source

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

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

  • "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

  • "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

  • "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

For more information, see Advanced cluster parameters.

Source

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

Identity and Access Management (IAM) access policy as a JSON-formatted string.

Source

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

Identity and Access Management (IAM) access policy as a JSON-formatted string.

Source

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

Identity and Access Management (IAM) access policy as a JSON-formatted string.

Source

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

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it.

Source

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

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it.

Source

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

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it.

Source

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

Adds a key-value pair to LogPublishingOptions.

To override the contents of this collection use set_log_publishing_options.

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

Source

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

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

Source

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

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

Source

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

Encryption at rest options for the domain.

Source

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

Encryption at rest options for the domain.

Source

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

Encryption at rest options for the domain.

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 node_to_node_encryption_options( self, input: NodeToNodeEncryptionOptions, ) -> Self

Node-to-node encryption options for the domain.

Source

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

Node-to-node encryption options for the domain.

Source

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

Node-to-node encryption options for the domain.

Source

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

Options for fine-grained access control.

Source

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

Options for fine-grained access control.

Source

pub fn get_advanced_security_options( &self, ) -> &Option<AdvancedSecurityOptionsInput>

Options for fine-grained access control.

Source

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

Configuration settings for enabling and managing IAM Identity Center.

Source

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

Configuration settings for enabling and managing IAM Identity Center.

Source

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

Configuration settings for enabling and managing IAM Identity Center.

Source

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

Options for Auto-Tune.

Source

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

Options for Auto-Tune.

Source

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

Options for Auto-Tune.

Source

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

This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.

Source

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

This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.

Source

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

This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.

Source

pub fn dry_run_mode(self, input: DryRunMode) -> Self

The type of dry run to perform.

  • Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.

  • Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.

Source

pub fn set_dry_run_mode(self, input: Option<DryRunMode>) -> Self

The type of dry run to perform.

  • Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.

  • Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.

Source

pub fn get_dry_run_mode(&self) -> &Option<DryRunMode>

The type of dry run to perform.

  • Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.

  • Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.

Source

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

Off-peak window options for the domain.

Source

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

Off-peak window options for the domain.

Source

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

Off-peak window options for 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 aiml_options(self, input: AimlOptionsInput) -> Self

Options for all machine learning features for the specified domain.

Source

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

Options for all machine learning features for the specified domain.

Source

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

Options for all machine learning features for the specified domain.

Trait Implementations§

Source§

impl Clone for UpdateDomainConfigFluentBuilder

Source§

fn clone(&self) -> UpdateDomainConfigFluentBuilder

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 UpdateDomainConfigFluentBuilder

Source§

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

Formats the value using the given formatter. Read more

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,