pub enum KnownCertificate {
Show 24 variants
AppleComputerIncRoot,
AppleRootCa,
AppleRootCaG2Root,
AppleRootCaG3Root,
AppleIstCa2G1,
AppleIstCa8G1,
ApplicationIntegration,
ApplicationIntegration2,
ApplicationIntegrationG3,
AppleApplicationIntegrationCa5G1,
AppleApplicationIntegrationCa7G1,
DeveloperAuthentication,
DeveloperIdG1,
DeveloperIdG2,
SoftwareUpdate,
Timestamp,
WwdrG1,
WwdrG2,
WwdrG3,
WwdrG4,
WwdrG5,
WwdrG6,
WwdrG7,
WwdrG8,
}
Expand description
Defines all known Apple certificates.
This crate embeds the raw certificate data for the various known Apple certificate authorities, as advertised at https://www.apple.com/certificateauthority/.
This enumeration defines all the ones we know about. Instances can be dereferenced into concrete CapturedX509Certificate to get at the underlying certificate and access its metadata.
Variants§
AppleComputerIncRoot
Apple Computer, Inc. Root Certificate.
C = US, O = “Apple Computer, Inc.”, OU = Apple Computer Certificate Authority, CN = Apple Root Certificate Authority
AppleRootCa
Apple Inc. Root Certificate
C = US, O = Apple Inc., OU = Apple Certification Authority, CN = Apple Root CA
AppleRootCaG2Root
Apple Root CA - G2 Root Certificate
CN = Apple Root CA - G2, OU = Apple Certification Authority, O = Apple Inc., C = US
AppleRootCaG3Root
Apple Root CA - G3 Root Certificate
CN = Apple Root CA - G3, OU = Apple Certification Authority, O = Apple Inc., C = US
AppleIstCa2G1
Apple IST CA 2 - G1 Certificate
CN = Apple IST CA 2 - G1, OU = Certification Authority, O = Apple Inc., C = US
AppleIstCa8G1
Apple IST CA 8 - G1 Certificate
CN = Apple IST CA 8 - G1, OU = Certification Authority, O = Apple Inc., C = US
ApplicationIntegration
Application Integration Certificate
C = US, O = Apple Inc., OU = Apple Certification Authority, CN = Apple Application Integration Certification Authority
ApplicationIntegration2
Application Integration 2 Certificate
CN = Apple Application Integration 2 Certification Authority, OU = Apple Certification Authority, O = Apple Inc., C = US
ApplicationIntegrationG3
Application Integration - G3 Certificate
CN = Apple Application Integration CA - G3, OU = Apple Certification Authority, O = Apple Inc., C = US
AppleApplicationIntegrationCa5G1
Apple Application Integration CA 5 - G1 Certificate
CN = Apple Application Integration CA 5 - G1, OU = Apple Certification Authority, O = Apple Inc., C = US
AppleApplicationIntegrationCa7G1
Apple Application Integration CA 7 - G1 Certificate
CN=Apple Application Integration CA 7 - G1, OU=Apple Certification Authority, O=Apple Inc., C=US
DeveloperAuthentication
Developer Authentication Certificate
CN = Developer Authentication Certification Authority, OU = Apple Worldwide Developer Relations, O = Apple Inc., C = US
DeveloperIdG1
Developer ID - G1 Certificate
CN = Developer ID Certification Authority, OU = Apple Certification Authority, O = Apple Inc., C = US
DeveloperIdG2
Developer ID - G2 Certificate.
CN = Developer ID Certification Authority, OU = G2, O = Apple Inc., C = US
SoftwareUpdate
Software Update Certificate
CN = Apple Software Update Certification Authority, OU = Certification Authority, O = Apple Inc., C = US
Timestamp
Timestamp Certificate
CN = Apple Timestamp Certification Authority, OU = Apple Certification Authority, O = Apple Inc., C = US
WwdrG1
Worldwide Developer Relations - G1 (Expiring 02/07/2023 21:48:47 UTC) Certificate
C = US, O = Apple Inc., OU = Apple Worldwide Developer Relations, CN = Apple Worldwide Developer Relations Certification Authority
WwdrG2
Worldwide Developer Relations - G2 (Expiring 05/06/2029 23:43:24 UTC) Certificate
CN = Apple Worldwide Developer Relations CA - G2, OU = Apple Certification Authority, O = Apple Inc., C = US
WwdrG3
Worldwide Developer Relations - G3 (Expiring 02/20/2030 00:00:00 UTC) Certificate
CN = Apple Worldwide Developer Relations Certification Authority, OU = G3, O = Apple Inc., C = US
WwdrG4
Worldwide Developer Relations - G4 (Expiring 12/10/2030 00:00:00 UTC) Certificate
CN = Apple Worldwide Developer Relations Certification Authority, OU = G4, O = Apple Inc., C = US
WwdrG5
Worldwide Developer Relations - G5 (Expiring 12/10/2030 00:00:00 UTC) Certificate
CN = Apple Worldwide Developer Relations Certification Authority, OU = G5, O = Apple Inc., C = US
WwdrG6
Worldwide Developer Relations - G6 (Expiring 03/19/2036 00:00:00 UTC) Certificate
CN = Apple Worldwide Developer Relations Certification Authority, OU = G6, O = Apple Inc., C = US
WwdrG7
Worldwide Developer Relations - G7 (Expiring 11/17/2023 20:40:52 UTC)
C=US, O=Apple Inc., OU=G7, CN=Apple Worldwide Developer Relations Certification Authority
WwdrG8
Worldwide Developer Relations - G8 (Expiring 01/24/2025 00:00:00 UTC)
C=US, O=Apple Inc., OU=G8, CN=Apple Worldwide Developer Relations Certification Authority
Implementations§
Source§impl KnownCertificate
impl KnownCertificate
Sourcepub fn all() -> &'static [&'static CapturedX509Certificate]
pub fn all() -> &'static [&'static CapturedX509Certificate]
Obtain a slice of all known KnownCertificate.
If you want to iterate over all certificates and find one, you can use this.
Sourcepub fn all_roots() -> &'static [&'static CapturedX509Certificate]
pub fn all_roots() -> &'static [&'static CapturedX509Certificate]
All of Apple’s known root certificate authority certificates.
Methods from Deref<Target = CapturedX509Certificate>§
Sourcepub fn constructed_data(&self) -> &[u8] ⓘ
pub fn constructed_data(&self) -> &[u8] ⓘ
Obtain the DER data that was used to construct this instance.
The data is guaranteed to not have been modified since the instance was constructed.
Sourcepub fn encode_pem(&self) -> String
pub fn encode_pem(&self) -> String
Encode the original contents of this certificate to PEM.
Sourcepub fn verify_signed_by_certificate(
&self,
other: impl AsRef<X509Certificate>,
) -> Result<(), X509CertificateError>
pub fn verify_signed_by_certificate( &self, other: impl AsRef<X509Certificate>, ) -> Result<(), X509CertificateError>
Verify that another certificate, other
, signed this certificate.
If this is a self-signed certificate, you can pass self
as the 2nd
argument.
This function isn’t exposed on X509Certificate because the exact bytes constituting the certificate’s internals need to be consulted to verify signatures. And since this type tracks the underlying bytes, we are guaranteed to have a pristine copy.
Sourcepub fn verify_signed_data(
&self,
signed_data: impl AsRef<[u8]>,
signature: impl AsRef<[u8]>,
) -> Result<(), X509CertificateError>
pub fn verify_signed_data( &self, signed_data: impl AsRef<[u8]>, signature: impl AsRef<[u8]>, ) -> Result<(), X509CertificateError>
Verify a signature over signed data purportedly signed by this certificate.
This is a wrapper to Self::verify_signed_data_with_algorithm() that will derive the verification algorithm from the public key type type and the signature algorithm indicated in this certificate. Typically these align. However, it is possible for a signature to be produced with a different digest algorithm from that indicated in this certificate.
Sourcepub fn verify_signed_data_with_algorithm(
&self,
signed_data: impl AsRef<[u8]>,
signature: impl AsRef<[u8]>,
verify_algorithm: &'static dyn VerificationAlgorithm,
) -> Result<(), X509CertificateError>
pub fn verify_signed_data_with_algorithm( &self, signed_data: impl AsRef<[u8]>, signature: impl AsRef<[u8]>, verify_algorithm: &'static dyn VerificationAlgorithm, ) -> Result<(), X509CertificateError>
Verify a signature over signed data using an explicit verification algorithm.
This is like Self::verify_signed_data() except the verification algorithm to use is passed in instead of derived from the default algorithm for the signing key’s type.
Sourcepub fn verify_signed_by_public_key(
&self,
public_key_data: impl AsRef<[u8]>,
) -> Result<(), X509CertificateError>
pub fn verify_signed_by_public_key( &self, public_key_data: impl AsRef<[u8]>, ) -> Result<(), X509CertificateError>
Verifies that this certificate was cryptographically signed using raw public key data from a signing key.
This function does the low-level work of extracting the signature and verification details from the current certificate and figuring out the correct combination of cryptography settings to apply to perform signature verification.
In many cases, an X.509 certificate is signed by another certificate. And since the public key is embedded in the X.509 certificate, it is easier to go through Self::verify_signed_by_certificate instead.
Sourcepub fn find_signing_certificate<'a>(
&self,
certs: impl Iterator<Item = &'a CapturedX509Certificate>,
) -> Option<&'a CapturedX509Certificate>
pub fn find_signing_certificate<'a>( &self, certs: impl Iterator<Item = &'a CapturedX509Certificate>, ) -> Option<&'a CapturedX509Certificate>
Attempt to find the issuing certificate of this one.
Given an iterable of certificates, we find the first certificate where we are able to verify that our signature was made by their public key.
This function can yield false negatives for cases where we don’t support the signature algorithm on the incoming certificates.
Sourcepub fn resolve_signing_chain<'a>(
&self,
certs: impl Iterator<Item = &'a CapturedX509Certificate>,
) -> Vec<&'a CapturedX509Certificate>
pub fn resolve_signing_chain<'a>( &self, certs: impl Iterator<Item = &'a CapturedX509Certificate>, ) -> Vec<&'a CapturedX509Certificate>
Attempt to resolve the signing chain of this certificate.
Given an iterable of certificates, we recursively resolve the chain of certificates that signed this one until we are no longer able to find any more certificates in the input set.
Like Self::find_signing_certificate, this can yield false negatives (read: an incomplete chain) due to run-time failures, such as lack of support for a certificate’s signature algorithm.
As a certificate is encountered, it is removed from the set of future candidates.
The traversal ends when we get to an identical certificate (its DER data is equivalent) or we couldn’t find a certificate in the remaining set that signed the last one.
Because we need to recursively verify certificates, the incoming iterator is buffered.
Methods from Deref<Target = X509Certificate>§
Sourcepub fn serial_number_asn1(&self) -> &Integer
pub fn serial_number_asn1(&self) -> &Integer
Obtain the serial number as the ASN.1 Integer type.
Sourcepub fn subject_name(&self) -> &Name
pub fn subject_name(&self) -> &Name
Obtain the certificate’s subject, as its ASN.1 Name type.
Sourcepub fn subject_common_name(&self) -> Option<String>
pub fn subject_common_name(&self) -> Option<String>
Obtain the Common Name (CN) attribute from the certificate’s subject, if set and decodable.
Sourcepub fn issuer_name(&self) -> &Name
pub fn issuer_name(&self) -> &Name
Obtain the certificate’s issuer, as its ASN.1 Name type.
Sourcepub fn issuer_common_name(&self) -> Option<String>
pub fn issuer_common_name(&self) -> Option<String>
Obtain the Common Name (CN) attribute from the certificate’s issuer, if set and decodable.
Sourcepub fn iter_extensions(&self) -> impl Iterator<Item = &Extension>
pub fn iter_extensions(&self) -> impl Iterator<Item = &Extension>
Iterate over extensions defined in this certificate.
Sourcepub fn encode_der_to(&self, fh: &mut impl Write) -> Result<(), Error>
pub fn encode_der_to(&self, fh: &mut impl Write) -> Result<(), Error>
Encode the certificate data structure using DER encoding.
(This is the common ASN.1 encoding format for X.509 certificates.)
This always serializes the internal ASN.1 data structure. If you call this on a wrapper type that has retained a copy of the original data, this may emit different data than that copy.
Sourcepub fn encode_ber_to(&self, fh: &mut impl Write) -> Result<(), Error>
pub fn encode_ber_to(&self, fh: &mut impl Write) -> Result<(), Error>
Encode the certificate data structure use BER encoding.
Sourcepub fn encode_der(&self) -> Result<Vec<u8>, Error>
pub fn encode_der(&self) -> Result<Vec<u8>, Error>
Encode the internal ASN.1 data structures to DER.
Sourcepub fn encode_ber(&self) -> Result<Vec<u8>, Error>
pub fn encode_ber(&self) -> Result<Vec<u8>, Error>
Obtain the BER encoded representation of this certificate.
Sourcepub fn write_pem(&self, fh: &mut impl Write) -> Result<(), Error>
pub fn write_pem(&self, fh: &mut impl Write) -> Result<(), Error>
Encode the certificate to PEM.
This will write a human-readable string with ------ BEGIN CERTIFICATE -------
armoring. This is a very common method for encoding certificates.
The underlying binary data is DER encoded.
Sourcepub fn encode_pem(&self) -> Result<String, Error>
pub fn encode_pem(&self) -> Result<String, Error>
Encode the certificate to a PEM string.
Sourcepub fn key_algorithm(&self) -> Option<KeyAlgorithm>
pub fn key_algorithm(&self) -> Option<KeyAlgorithm>
Attempt to resolve a known KeyAlgorithm used by the private key associated with this certificate.
If this crate isn’t aware of the OID associated with the key algorithm,
None
is returned.
Sourcepub fn key_algorithm_oid(&self) -> &Oid
pub fn key_algorithm_oid(&self) -> &Oid
Obtain the OID of the private key’s algorithm.
Sourcepub fn signature_algorithm(&self) -> Option<SignatureAlgorithm>
pub fn signature_algorithm(&self) -> Option<SignatureAlgorithm>
Obtain the [SignatureAlgorithm this certificate will use.
Returns None if we failed to resolve an instance (probably because we don’t recognize the algorithm).
Sourcepub fn signature_algorithm_oid(&self) -> &Oid
pub fn signature_algorithm_oid(&self) -> &Oid
Obtain the OID of the signature algorithm this certificate will use.
Sourcepub fn signature_signature_algorithm(&self) -> Option<SignatureAlgorithm>
pub fn signature_signature_algorithm(&self) -> Option<SignatureAlgorithm>
Obtain the SignatureAlgorithm used to sign this certificate.
Returns None if we failed to resolve an instance (probably because we don’t recognize that algorithm).
Sourcepub fn signature_signature_algorithm_oid(&self) -> &Oid
pub fn signature_signature_algorithm_oid(&self) -> &Oid
Obtain the OID of the signature algorithm used to sign this certificate.
Sourcepub fn public_key_data(&self) -> Bytes
pub fn public_key_data(&self) -> Bytes
Obtain the raw data constituting this certificate’s public key.
A copy of the data is returned.
Sourcepub fn rsa_public_key_data(&self) -> Result<RsaPublicKey, X509CertificateError>
pub fn rsa_public_key_data(&self) -> Result<RsaPublicKey, X509CertificateError>
Attempt to parse the public key data as RsaPublicKey parameters.
Note that the raw integer value for modulus has a leading 0 byte. So its
raw length will be 1 greater than key length. e.g. an RSA 2048 key will
have value.modulus.as_slice().len() == 257
instead of 256
.
Sourcepub fn compare_issuer(&self, other: &X509Certificate) -> Ordering
pub fn compare_issuer(&self, other: &X509Certificate) -> Ordering
Compare 2 instances, sorting them so the issuer comes before the issued.
This function examines the Self::issuer_name and Self::subject_name fields of 2 certificates, attempting to sort them so the issuing certificate comes before the issued certificate.
This function performs a strict compare of the ASN.1 Name data. The assumption here is that the issuing certificate’s subject Name is identical to the issued’s issuer Name. This assumption is often true. But it likely isn’t always true, so this function may not produce reliable results.
Sourcepub fn subject_is_issuer(&self) -> bool
pub fn subject_is_issuer(&self) -> bool
Sourcepub fn fingerprint(&self, algorithm: DigestAlgorithm) -> Result<Digest, Error>
pub fn fingerprint(&self, algorithm: DigestAlgorithm) -> Result<Digest, Error>
Obtain the fingerprint for this certificate given a digest algorithm.
Sourcepub fn sha1_fingerprint(&self) -> Result<Digest, Error>
pub fn sha1_fingerprint(&self) -> Result<Digest, Error>
Obtain the SHA-1 fingerprint of this certificate.
Sourcepub fn sha256_fingerprint(&self) -> Result<Digest, Error>
pub fn sha256_fingerprint(&self) -> Result<Digest, Error>
Obtain the SHA-256 fingerprint of this certificate.
Sourcepub fn tbs_certificate(&self) -> &TbsCertificate
pub fn tbs_certificate(&self) -> &TbsCertificate
Obtain the raw rfc5280::TbsCertificate for this certificate.
Sourcepub fn validity_not_before(&self) -> DateTime<Utc>
pub fn validity_not_before(&self) -> DateTime<Utc>
Obtain the certificate validity “not before” time.
Sourcepub fn validity_not_after(&self) -> DateTime<Utc>
pub fn validity_not_after(&self) -> DateTime<Utc>
Obtain the certificate validity “not after” time.
Sourcepub fn time_constraints_valid(
&self,
compare_time: Option<DateTime<Utc>>,
) -> bool
pub fn time_constraints_valid( &self, compare_time: Option<DateTime<Utc>>, ) -> bool
Determine whether a time is between the validity constraints in the certificate.
i.e. check whether a certificate is “expired.”
Receives a date time to check against.
If None
, the current time is used. This relies on the machine’s
wall clock to be accurate, of course.
Trait Implementations§
Source§impl AsRef<CapturedX509Certificate> for KnownCertificate
impl AsRef<CapturedX509Certificate> for KnownCertificate
Source§fn as_ref(&self) -> &CapturedX509Certificate
fn as_ref(&self) -> &CapturedX509Certificate
Source§impl Clone for KnownCertificate
impl Clone for KnownCertificate
Source§fn clone(&self) -> KnownCertificate
fn clone(&self) -> KnownCertificate
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for KnownCertificate
impl Debug for KnownCertificate
Source§impl Deref for KnownCertificate
impl Deref for KnownCertificate
Source§impl PartialEq for KnownCertificate
impl PartialEq for KnownCertificate
impl Copy for KnownCertificate
impl Eq for KnownCertificate
impl StructuralPartialEq for KnownCertificate
Auto Trait Implementations§
impl Freeze for KnownCertificate
impl RefUnwindSafe for KnownCertificate
impl Send for KnownCertificate
impl Sync for KnownCertificate
impl Unpin for KnownCertificate
impl UnwindSafe for KnownCertificate
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
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>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
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>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
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>
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
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>
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.