AwsCertificateManagerCertificateDetailsBuilder

Struct AwsCertificateManagerCertificateDetailsBuilder 

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

Implementations§

Source§

impl AwsCertificateManagerCertificateDetailsBuilder

Source

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

The ARN of the private certificate authority (CA) that will be used to issue the certificate.

Source

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

The ARN of the private certificate authority (CA) that will be used to issue the certificate.

Source

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

The ARN of the private certificate authority (CA) that will be used to issue the certificate.

Source

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

Indicates when the certificate was requested.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

Indicates when the certificate was requested.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

Indicates when the certificate was requested.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

Source

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

The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

Source

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

The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

Source

pub fn domain_validation_options( self, input: AwsCertificateManagerCertificateDomainValidationOption, ) -> Self

Appends an item to domain_validation_options.

To override the contents of this collection use set_domain_validation_options.

Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.

Only provided if the certificate type is AMAZON_ISSUED.

Source

pub fn set_domain_validation_options( self, input: Option<Vec<AwsCertificateManagerCertificateDomainValidationOption>>, ) -> Self

Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.

Only provided if the certificate type is AMAZON_ISSUED.

Source

pub fn get_domain_validation_options( &self, ) -> &Option<Vec<AwsCertificateManagerCertificateDomainValidationOption>>

Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.

Only provided if the certificate type is AMAZON_ISSUED.

Source

pub fn extended_key_usages( self, input: AwsCertificateManagerCertificateExtendedKeyUsage, ) -> Self

Appends an item to extended_key_usages.

To override the contents of this collection use set_extended_key_usages.

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

Source

pub fn set_extended_key_usages( self, input: Option<Vec<AwsCertificateManagerCertificateExtendedKeyUsage>>, ) -> Self

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

Source

pub fn get_extended_key_usages( &self, ) -> &Option<Vec<AwsCertificateManagerCertificateExtendedKeyUsage>>

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

Source

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

For a failed certificate request, the reason for the failure.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

Source

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

For a failed certificate request, the reason for the failure.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

Source

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

For a failed certificate request, the reason for the failure.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

Source

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

Indicates when the certificate was imported. Provided if the certificate type is IMPORTED.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

Indicates when the certificate was imported. Provided if the certificate type is IMPORTED.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

Indicates when the certificate was imported. Provided if the certificate type is IMPORTED.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

Appends an item to in_use_by.

To override the contents of this collection use set_in_use_by.

The list of ARNs for the Amazon Web Services resources that use the certificate.

Source

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

The list of ARNs for the Amazon Web Services resources that use the certificate.

Source

pub fn get_in_use_by(&self) -> &Option<Vec<String>>

The list of ARNs for the Amazon Web Services resources that use the certificate.

Source

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

Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

The name of the certificate authority that issued and signed the certificate.

Source

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

The name of the certificate authority that issued and signed the certificate.

Source

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

The name of the certificate authority that issued and signed the certificate.

Source

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

The algorithm that was used to generate the public-private key pair.

Valid values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1

Source

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

The algorithm that was used to generate the public-private key pair.

Valid values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1

Source

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

The algorithm that was used to generate the public-private key pair.

Valid values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1

Source

pub fn key_usages(self, input: AwsCertificateManagerCertificateKeyUsage) -> Self

Appends an item to key_usages.

To override the contents of this collection use set_key_usages.

A list of key usage X.509 v3 extension objects.

Source

pub fn set_key_usages( self, input: Option<Vec<AwsCertificateManagerCertificateKeyUsage>>, ) -> Self

A list of key usage X.509 v3 extension objects.

Source

pub fn get_key_usages( &self, ) -> &Option<Vec<AwsCertificateManagerCertificateKeyUsage>>

A list of key usage X.509 v3 extension objects.

Source

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

The time after which the certificate becomes invalid.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

The time after which the certificate becomes invalid.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

The time after which the certificate becomes invalid.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

The time before which the certificate is not valid.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

The time before which the certificate is not valid.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

The time before which the certificate is not valid.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

pub fn options(self, input: AwsCertificateManagerCertificateOptions) -> Self

Provides a value that specifies whether to add the certificate to a transparency log.

Source

pub fn set_options( self, input: Option<AwsCertificateManagerCertificateOptions>, ) -> Self

Provides a value that specifies whether to add the certificate to a transparency log.

Source

pub fn get_options(&self) -> &Option<AwsCertificateManagerCertificateOptions>

Provides a value that specifies whether to add the certificate to a transparency log.

Source

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

Whether the certificate is eligible for renewal.

Valid values: ELIGIBLE | INELIGIBLE

Source

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

Whether the certificate is eligible for renewal.

Valid values: ELIGIBLE | INELIGIBLE

Source

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

Whether the certificate is eligible for renewal.

Valid values: ELIGIBLE | INELIGIBLE

Source

pub fn renewal_summary( self, input: AwsCertificateManagerCertificateRenewalSummary, ) -> Self

Information about the status of the Certificate Manager managed renewal for the certificate. Provided only when the certificate type is AMAZON_ISSUED.

Source

pub fn set_renewal_summary( self, input: Option<AwsCertificateManagerCertificateRenewalSummary>, ) -> Self

Information about the status of the Certificate Manager managed renewal for the certificate. Provided only when the certificate type is AMAZON_ISSUED.

Source

pub fn get_renewal_summary( &self, ) -> &Option<AwsCertificateManagerCertificateRenewalSummary>

Information about the status of the Certificate Manager managed renewal for the certificate. Provided only when the certificate type is AMAZON_ISSUED.

Source

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

The serial number of the certificate.

Source

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

The serial number of the certificate.

Source

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

The serial number of the certificate.

Source

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

The algorithm that was used to sign the certificate.

Source

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

The algorithm that was used to sign the certificate.

Source

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

The algorithm that was used to sign the certificate.

Source

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

The status of the certificate.

Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

Source

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

The status of the certificate.

Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

Source

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

The status of the certificate.

Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

Source

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

The name of the entity that is associated with the public key contained in the certificate.

Source

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

The name of the entity that is associated with the public key contained in the certificate.

Source

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

The name of the entity that is associated with the public key contained in the certificate.

Source

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

Appends an item to subject_alternative_names.

To override the contents of this collection use set_subject_alternative_names.

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate.

The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

Source

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

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate.

The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

Source

pub fn get_subject_alternative_names(&self) -> &Option<Vec<String>>

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate.

The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

Source

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

The source of the certificate. For certificates that Certificate Manager provides, Type is AMAZON_ISSUED. For certificates that are imported with ImportCertificate, Type is IMPORTED.

Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE

Source

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

The source of the certificate. For certificates that Certificate Manager provides, Type is AMAZON_ISSUED. For certificates that are imported with ImportCertificate, Type is IMPORTED.

Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE

Source

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

The source of the certificate. For certificates that Certificate Manager provides, Type is AMAZON_ISSUED. For certificates that are imported with ImportCertificate, Type is IMPORTED.

Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE

Source

pub fn build(self) -> AwsCertificateManagerCertificateDetails

Consumes the builder and constructs a AwsCertificateManagerCertificateDetails.

Trait Implementations§

Source§

impl Clone for AwsCertificateManagerCertificateDetailsBuilder

Source§

fn clone(&self) -> AwsCertificateManagerCertificateDetailsBuilder

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 AwsCertificateManagerCertificateDetailsBuilder

Source§

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

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

impl Default for AwsCertificateManagerCertificateDetailsBuilder

Source§

fn default() -> AwsCertificateManagerCertificateDetailsBuilder

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

impl PartialEq for AwsCertificateManagerCertificateDetailsBuilder

Source§

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

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