#[non_exhaustive]pub struct AwsCertificateManagerCertificateDetailsBuilder { /* private fields */ }Expand description
A builder for AwsCertificateManagerCertificateDetails.
Implementations§
Source§impl AwsCertificateManagerCertificateDetailsBuilder
impl AwsCertificateManagerCertificateDetailsBuilder
The ARN of the private certificate authority (CA) that will be used to issue the certificate.
The ARN of the private certificate authority (CA) that will be used to issue the certificate.
The ARN of the private certificate authority (CA) that will be used to issue the certificate.
Sourcepub fn created_at(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_created_at(self, input: Option<String>) -> Self
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.
Sourcepub fn get_created_at(&self) -> &Option<String>
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.
Sourcepub fn domain_name(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_domain_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_domain_name(&self) -> &Option<String>
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.
Sourcepub fn domain_validation_options(
self,
input: AwsCertificateManagerCertificateDomainValidationOption,
) -> Self
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.
Sourcepub fn set_domain_validation_options(
self,
input: Option<Vec<AwsCertificateManagerCertificateDomainValidationOption>>,
) -> Self
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.
Sourcepub fn get_domain_validation_options(
&self,
) -> &Option<Vec<AwsCertificateManagerCertificateDomainValidationOption>>
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.
Sourcepub fn extended_key_usages(
self,
input: AwsCertificateManagerCertificateExtendedKeyUsage,
) -> Self
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).
Sourcepub fn set_extended_key_usages(
self,
input: Option<Vec<AwsCertificateManagerCertificateExtendedKeyUsage>>,
) -> Self
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).
Sourcepub fn get_extended_key_usages(
&self,
) -> &Option<Vec<AwsCertificateManagerCertificateExtendedKeyUsage>>
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).
Sourcepub fn failure_reason(self, input: impl Into<String>) -> Self
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
Sourcepub fn set_failure_reason(self, input: Option<String>) -> Self
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
Sourcepub fn get_failure_reason(&self) -> &Option<String>
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
Sourcepub fn imported_at(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_imported_at(self, input: Option<String>) -> Self
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.
Sourcepub fn get_imported_at(&self) -> &Option<String>
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.
Sourcepub fn in_use_by(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_in_use_by(self, input: Option<Vec<String>>) -> Self
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.
Sourcepub fn get_in_use_by(&self) -> &Option<Vec<String>>
pub fn get_in_use_by(&self) -> &Option<Vec<String>>
The list of ARNs for the Amazon Web Services resources that use the certificate.
Sourcepub fn issued_at(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_issued_at(self, input: Option<String>) -> Self
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.
Sourcepub fn get_issued_at(&self) -> &Option<String>
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.
Sourcepub fn issuer(self, input: impl Into<String>) -> Self
pub fn issuer(self, input: impl Into<String>) -> Self
The name of the certificate authority that issued and signed the certificate.
Sourcepub fn set_issuer(self, input: Option<String>) -> Self
pub fn set_issuer(self, input: Option<String>) -> Self
The name of the certificate authority that issued and signed the certificate.
Sourcepub fn get_issuer(&self) -> &Option<String>
pub fn get_issuer(&self) -> &Option<String>
The name of the certificate authority that issued and signed the certificate.
Sourcepub fn key_algorithm(self, input: impl Into<String>) -> Self
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
Sourcepub fn set_key_algorithm(self, input: Option<String>) -> Self
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
Sourcepub fn get_key_algorithm(&self) -> &Option<String>
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
Sourcepub fn key_usages(self, input: AwsCertificateManagerCertificateKeyUsage) -> Self
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.
Sourcepub fn set_key_usages(
self,
input: Option<Vec<AwsCertificateManagerCertificateKeyUsage>>,
) -> Self
pub fn set_key_usages( self, input: Option<Vec<AwsCertificateManagerCertificateKeyUsage>>, ) -> Self
A list of key usage X.509 v3 extension objects.
Sourcepub fn get_key_usages(
&self,
) -> &Option<Vec<AwsCertificateManagerCertificateKeyUsage>>
pub fn get_key_usages( &self, ) -> &Option<Vec<AwsCertificateManagerCertificateKeyUsage>>
A list of key usage X.509 v3 extension objects.
Sourcepub fn not_after(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_not_after(self, input: Option<String>) -> Self
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.
Sourcepub fn get_not_after(&self) -> &Option<String>
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.
Sourcepub fn not_before(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_not_before(self, input: Option<String>) -> Self
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.
Sourcepub fn get_not_before(&self) -> &Option<String>
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.
Sourcepub fn options(self, input: AwsCertificateManagerCertificateOptions) -> Self
pub fn options(self, input: AwsCertificateManagerCertificateOptions) -> Self
Provides a value that specifies whether to add the certificate to a transparency log.
Sourcepub fn set_options(
self,
input: Option<AwsCertificateManagerCertificateOptions>,
) -> Self
pub fn set_options( self, input: Option<AwsCertificateManagerCertificateOptions>, ) -> Self
Provides a value that specifies whether to add the certificate to a transparency log.
Sourcepub fn get_options(&self) -> &Option<AwsCertificateManagerCertificateOptions>
pub fn get_options(&self) -> &Option<AwsCertificateManagerCertificateOptions>
Provides a value that specifies whether to add the certificate to a transparency log.
Sourcepub fn renewal_eligibility(self, input: impl Into<String>) -> Self
pub fn renewal_eligibility(self, input: impl Into<String>) -> Self
Whether the certificate is eligible for renewal.
Valid values: ELIGIBLE | INELIGIBLE
Sourcepub fn set_renewal_eligibility(self, input: Option<String>) -> Self
pub fn set_renewal_eligibility(self, input: Option<String>) -> Self
Whether the certificate is eligible for renewal.
Valid values: ELIGIBLE | INELIGIBLE
Sourcepub fn get_renewal_eligibility(&self) -> &Option<String>
pub fn get_renewal_eligibility(&self) -> &Option<String>
Whether the certificate is eligible for renewal.
Valid values: ELIGIBLE | INELIGIBLE
Sourcepub fn renewal_summary(
self,
input: AwsCertificateManagerCertificateRenewalSummary,
) -> Self
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.
Sourcepub fn set_renewal_summary(
self,
input: Option<AwsCertificateManagerCertificateRenewalSummary>,
) -> Self
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.
Sourcepub fn get_renewal_summary(
&self,
) -> &Option<AwsCertificateManagerCertificateRenewalSummary>
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.
Sourcepub fn set_serial(self, input: Option<String>) -> Self
pub fn set_serial(self, input: Option<String>) -> Self
The serial number of the certificate.
Sourcepub fn get_serial(&self) -> &Option<String>
pub fn get_serial(&self) -> &Option<String>
The serial number of the certificate.
Sourcepub fn signature_algorithm(self, input: impl Into<String>) -> Self
pub fn signature_algorithm(self, input: impl Into<String>) -> Self
The algorithm that was used to sign the certificate.
Sourcepub fn set_signature_algorithm(self, input: Option<String>) -> Self
pub fn set_signature_algorithm(self, input: Option<String>) -> Self
The algorithm that was used to sign the certificate.
Sourcepub fn get_signature_algorithm(&self) -> &Option<String>
pub fn get_signature_algorithm(&self) -> &Option<String>
The algorithm that was used to sign the certificate.
Sourcepub fn status(self, input: impl Into<String>) -> Self
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
Sourcepub fn set_status(self, input: Option<String>) -> Self
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
Sourcepub fn get_status(&self) -> &Option<String>
pub fn get_status(&self) -> &Option<String>
The status of the certificate.
Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED
Sourcepub fn subject(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_subject(self, input: Option<String>) -> Self
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.
Sourcepub fn get_subject(&self) -> &Option<String>
pub fn get_subject(&self) -> &Option<String>
The name of the entity that is associated with the public key contained in the certificate.
Sourcepub fn subject_alternative_names(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_subject_alternative_names(self, input: Option<Vec<String>>) -> Self
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.
Sourcepub fn get_subject_alternative_names(&self) -> &Option<Vec<String>>
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.
Sourcepub fn type(self, input: impl Into<String>) -> Self
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
Sourcepub fn set_type(self, input: Option<String>) -> Self
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
Sourcepub fn get_type(&self) -> &Option<String>
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
Sourcepub fn build(self) -> AwsCertificateManagerCertificateDetails
pub fn build(self) -> AwsCertificateManagerCertificateDetails
Consumes the builder and constructs a AwsCertificateManagerCertificateDetails.
Trait Implementations§
Source§impl Clone for AwsCertificateManagerCertificateDetailsBuilder
impl Clone for AwsCertificateManagerCertificateDetailsBuilder
Source§fn clone(&self) -> AwsCertificateManagerCertificateDetailsBuilder
fn clone(&self) -> AwsCertificateManagerCertificateDetailsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for AwsCertificateManagerCertificateDetailsBuilder
impl Default for AwsCertificateManagerCertificateDetailsBuilder
Source§fn default() -> AwsCertificateManagerCertificateDetailsBuilder
fn default() -> AwsCertificateManagerCertificateDetailsBuilder
Source§impl PartialEq for AwsCertificateManagerCertificateDetailsBuilder
impl PartialEq for AwsCertificateManagerCertificateDetailsBuilder
Source§fn eq(&self, other: &AwsCertificateManagerCertificateDetailsBuilder) -> bool
fn eq(&self, other: &AwsCertificateManagerCertificateDetailsBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for AwsCertificateManagerCertificateDetailsBuilder
Auto Trait Implementations§
impl Freeze for AwsCertificateManagerCertificateDetailsBuilder
impl RefUnwindSafe for AwsCertificateManagerCertificateDetailsBuilder
impl Send for AwsCertificateManagerCertificateDetailsBuilder
impl Sync for AwsCertificateManagerCertificateDetailsBuilder
impl Unpin for AwsCertificateManagerCertificateDetailsBuilder
impl UnwindSafe for AwsCertificateManagerCertificateDetailsBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);