Enum rocket::mtls::x509::X509Error

source ·
pub enum X509Error {
Show 22 variants Generic, InvalidVersion, InvalidSerial, InvalidAlgorithmIdentifier, InvalidX509Name, InvalidDate, InvalidSPKI, InvalidSubjectUID, InvalidIssuerUID, InvalidExtensions, InvalidAttributes, DuplicateExtensions, DuplicateAttributes, InvalidSignatureValue, InvalidTbsCertificate, InvalidUserCertificate, InvalidCertificate, SignatureVerificationError, SignatureUnsupportedAlgorithm, InvalidNumber, Der(Error), NomError(ErrorKind),
}
Available on crate feature mtls only.
Expand description

An error that can occur while parsing or validating a certificate.

Variants§

§

Generic

§

InvalidVersion

§

InvalidSerial

§

InvalidAlgorithmIdentifier

§

InvalidX509Name

§

InvalidDate

§

InvalidSPKI

§

InvalidSubjectUID

§

InvalidIssuerUID

§

InvalidExtensions

§

InvalidAttributes

§

DuplicateExtensions

§

DuplicateAttributes

§

InvalidSignatureValue

§

InvalidTbsCertificate

§

InvalidUserCertificate

§

InvalidCertificate

Top-level certificate structure is invalid

§

SignatureVerificationError

§

SignatureUnsupportedAlgorithm

§

InvalidNumber

§

Der(Error)

§

NomError(ErrorKind)

Trait Implementations§

source§

impl Clone for X509Error

source§

fn clone(&self) -> X509Error

Returns a copy 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 X509Error

source§

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

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

impl Display for X509Error

source§

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

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

impl Error for X509Error

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
source§

impl From<Err<Error>> for X509Error

source§

fn from(e: Err<Error>) -> X509Error

Converts to this type from the input type.
source§

impl From<Err<X509Error>> for X509Error

source§

fn from(e: Err<X509Error>) -> X509Error

Converts to this type from the input type.
source§

impl From<Error> for X509Error

source§

fn from(source: Error) -> X509Error

Converts to this type from the input type.
source§

impl From<ErrorKind> for X509Error

source§

fn from(e: ErrorKind) -> X509Error

Converts to this type from the input type.
source§

impl From<X509Error> for Err<X509Error>

source§

fn from(e: X509Error) -> Err<X509Error>

Converts to this type from the input type.
source§

impl<'a> FromDer<'a, X509Error> for ASN1Time

source§

fn from_der(i: &[u8]) -> Result<(&[u8], ASN1Time), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for AttributeTypeAndValue<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], AttributeTypeAndValue<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for AuthorityInfoAccess<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], AuthorityInfoAccess<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for AuthorityKeyIdentifier<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], AuthorityKeyIdentifier<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for BasicConstraints

source§

fn from_der(i: &'a [u8]) -> Result<(&'a [u8], BasicConstraints), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for CRLDistributionPoints<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], CRLDistributionPoints<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for CertificateRevocationList<'a>

CertificateList  ::=  SEQUENCE  {
     tbsCertList          TBSCertList,
     signatureAlgorithm   AlgorithmIdentifier,
     signatureValue       BIT STRING  }
source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], CertificateRevocationList<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for ExtendedKeyUsage<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], ExtendedKeyUsage<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for ExtensionRequest<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], ExtensionRequest<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for GeneralName<'a>

source§

fn from_der(i: &'a [u8]) -> Result<(&'a [u8], GeneralName<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for InhibitAnyPolicy

source§

fn from_der(i: &'a [u8]) -> Result<(&'a [u8], InhibitAnyPolicy), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for IssuerAlternativeName<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], IssuerAlternativeName<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for KeyIdentifier<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], KeyIdentifier<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for KeyUsage

source§

fn from_der(i: &'a [u8]) -> Result<(&'a [u8], KeyUsage), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for NSCertType

source§

fn from_der(i: &'a [u8]) -> Result<(&'a [u8], NSCertType), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for NameConstraints<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], NameConstraints<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for PolicyConstraints

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], PolicyConstraints), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for PolicyMappings<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], PolicyMappings<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for RSAPublicKey<'a>

source§

fn from_der( bytes: &'a [u8], ) -> Result<(&'a [u8], RSAPublicKey<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for RelativeDistinguishedName<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], RelativeDistinguishedName<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for RevokedCertificate<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], RevokedCertificate<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for SubjectAlternativeName<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], SubjectAlternativeName<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for SubjectPublicKeyInfo<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], SubjectPublicKeyInfo<'a>), Err<X509Error>>

Parse the SubjectPublicKeyInfo struct portion of a DER-encoded X.509 Certificate

source§

impl<'a> FromDer<'a, X509Error> for TbsCertList<'a>

source§

fn from_der(i: &'a [u8]) -> Result<(&'a [u8], TbsCertList<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for TbsCertificate<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], TbsCertificate<'a>), Err<X509Error>>

Parse a DER-encoded TbsCertificate object

TBSCertificate  ::=  SEQUENCE  {
     version         [0]  Version DEFAULT v1,
     serialNumber         CertificateSerialNumber,
     signature            AlgorithmIdentifier,
     issuer               Name,
     validity             Validity,
     subject              Name,
     subjectPublicKeyInfo SubjectPublicKeyInfo,
     issuerUniqueID  [1]  IMPLICIT UniqueIdentifier OPTIONAL,
                          -- If present, version MUST be v2 or v3
     subjectUniqueID [2]  IMPLICIT UniqueIdentifier OPTIONAL,
                          -- If present, version MUST be v2 or v3
     extensions      [3]  Extensions OPTIONAL
                          -- If present, version MUST be v3 --  }
source§

impl<'a> FromDer<'a, X509Error> for Validity

source§

fn from_der(i: &[u8]) -> Result<(&[u8], Validity), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for X509Certificate<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], X509Certificate<'a>), Err<X509Error>>

Parse a DER-encoded X.509 Certificate, and return the remaining of the input and the built object.

The returned object uses zero-copy, and so has the same lifetime as the input.

Note that only parsing is done, not validation.

Certificate  ::=  SEQUENCE  {
        tbsCertificate       TBSCertificate,
        signatureAlgorithm   AlgorithmIdentifier,
        signatureValue       BIT STRING  }
§Example

To parse a certificate and print the subject and issuer:

let res = parse_x509_certificate(DER);
match res {
    Ok((_rem, x509)) => {
        let subject = x509.subject();
        let issuer = x509.issuer();
        println!("X.509 Subject: {}", subject);
        println!("X.509 Issuer: {}", issuer);
    },
    _ => panic!("x509 parsing failed: {:?}", res),
}
source§

impl<'a> FromDer<'a, X509Error> for X509CertificationRequest<'a>

CertificationRequest ::= SEQUENCE {
    certificationRequestInfo CertificationRequestInfo,
    signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
    signature          BIT STRING
}
source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], X509CertificationRequest<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for X509CertificationRequestInfo<'a>

CertificationRequestInfo ::= SEQUENCE {
     version       INTEGER { v1(0) } (v1,...),
     subject       Name,
     subjectPKInfo SubjectPublicKeyInfo{{ PKInfoAlgorithms }},
     attributes    [0] Attributes{{ CRIAttributes }}
}
source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], X509CertificationRequestInfo<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for X509CriAttribute<'a>

source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], X509CriAttribute<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for X509Extension<'a>

Extension  ::=  SEQUENCE  {
    extnID      OBJECT IDENTIFIER,
    critical    BOOLEAN DEFAULT FALSE,
    extnValue   OCTET STRING  }
source§

fn from_der( i: &'a [u8], ) -> Result<(&'a [u8], X509Extension<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'a> FromDer<'a, X509Error> for X509Name<'a>

source§

fn from_der(i: &'a [u8]) -> Result<(&'a [u8], X509Name<'a>), Err<X509Error>>

Parse the X.501 type Name, used for ex in issuer and subject of a X.509 certificate

source§

impl<'a> FromDer<'a, X509Error> for X509Version

source§

fn from_der(i: &'a [u8]) -> Result<(&'a [u8], X509Version), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<'ber, 'a> FromDer<'ber, X509Error> for AlgorithmIdentifier<'a>
where 'ber: 'a,

source§

fn from_der( bytes: &'ber [u8], ) -> Result<(&'ber [u8], AlgorithmIdentifier<'a>), Err<X509Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)
source§

impl<I> ParseError<I> for X509Error

source§

fn from_error_kind(_input: I, kind: ErrorKind) -> X509Error

Creates an error from the input position and an ErrorKind
source§

fn append(_input: I, kind: ErrorKind, _other: X509Error) -> X509Error

Combines an existing error with a new one created from the input position and an ErrorKind. This is useful when backtracking through a parse tree, accumulating error context on the way
source§

fn from_char(input: I, _: char) -> Self

Creates an error from an input position and an expected character
source§

fn or(self, other: Self) -> Self

Combines two existing errors. This function is used to compare errors generated in various branches of alt.
source§

impl<'a> Parser<&'a [u8], TbsCertificate<'a>, X509Error> for TbsCertificateParser

source§

fn parse( &mut self, input: &'a [u8], ) -> Result<(&'a [u8], TbsCertificate<'a>), Err<X509Error>>

A parser takes in input type, and returns a Result containing either the remaining input and the output value, or an error
source§

fn map<G, O2>(self, g: G) -> Map<Self, G, O>
where G: Fn(O) -> O2, Self: Sized,

Maps a function over the result of a parser
source§

fn flat_map<G, H, O2>(self, g: G) -> FlatMap<Self, G, O>
where G: FnMut(O) -> H, H: Parser<I, O2, E>, Self: Sized,

Creates a second parser from the output of the first one, then apply over the rest of the input
source§

fn and_then<G, O2>(self, g: G) -> AndThen<Self, G, O>
where G: Parser<O, O2, E>, Self: Sized,

Applies a second parser over the output of the first one
source§

fn and<G, O2>(self, g: G) -> And<Self, G>
where G: Parser<I, O2, E>, Self: Sized,

Applies a second parser after the first one, return their results as a tuple
source§

fn or<G>(self, g: G) -> Or<Self, G>
where G: Parser<I, O, E>, Self: Sized,

Applies a second parser over the input if the first one failed
source§

fn into<O2, E2>(self) -> Into<Self, O, O2, E, E2>
where O2: From<O>, E2: From<E>, Self: Sized,

automatically converts the parser’s output and error values to another type, as long as they implement the From trait
source§

impl<'a> Parser<&'a [u8], X509Certificate<'a>, X509Error> for X509CertificateParser

source§

fn parse( &mut self, input: &'a [u8], ) -> Result<(&'a [u8], X509Certificate<'a>), Err<X509Error>>

A parser takes in input type, and returns a Result containing either the remaining input and the output value, or an error
source§

fn map<G, O2>(self, g: G) -> Map<Self, G, O>
where G: Fn(O) -> O2, Self: Sized,

Maps a function over the result of a parser
source§

fn flat_map<G, H, O2>(self, g: G) -> FlatMap<Self, G, O>
where G: FnMut(O) -> H, H: Parser<I, O2, E>, Self: Sized,

Creates a second parser from the output of the first one, then apply over the rest of the input
source§

fn and_then<G, O2>(self, g: G) -> AndThen<Self, G, O>
where G: Parser<O, O2, E>, Self: Sized,

Applies a second parser over the output of the first one
source§

fn and<G, O2>(self, g: G) -> And<Self, G>
where G: Parser<I, O2, E>, Self: Sized,

Applies a second parser after the first one, return their results as a tuple
source§

fn or<G>(self, g: G) -> Or<Self, G>
where G: Parser<I, O, E>, Self: Sized,

Applies a second parser over the input if the first one failed
source§

fn into<O2, E2>(self) -> Into<Self, O, O2, E, E2>
where O2: From<O>, E2: From<E>, Self: Sized,

automatically converts the parser’s output and error values to another type, as long as they implement the From trait
source§

impl<'a> Parser<&'a [u8], X509Extension<'a>, X509Error> for X509ExtensionParser

source§

fn parse( &mut self, input: &'a [u8], ) -> Result<(&'a [u8], X509Extension<'a>), Err<X509Error>>

A parser takes in input type, and returns a Result containing either the remaining input and the output value, or an error
source§

fn map<G, O2>(self, g: G) -> Map<Self, G, O>
where G: Fn(O) -> O2, Self: Sized,

Maps a function over the result of a parser
source§

fn flat_map<G, H, O2>(self, g: G) -> FlatMap<Self, G, O>
where G: FnMut(O) -> H, H: Parser<I, O2, E>, Self: Sized,

Creates a second parser from the output of the first one, then apply over the rest of the input
source§

fn and_then<G, O2>(self, g: G) -> AndThen<Self, G, O>
where G: Parser<O, O2, E>, Self: Sized,

Applies a second parser over the output of the first one
source§

fn and<G, O2>(self, g: G) -> And<Self, G>
where G: Parser<I, O2, E>, Self: Sized,

Applies a second parser after the first one, return their results as a tuple
source§

fn or<G>(self, g: G) -> Or<Self, G>
where G: Parser<I, O, E>, Self: Sized,

Applies a second parser over the input if the first one failed
source§

fn into<O2, E2>(self) -> Into<Self, O, O2, E, E2>
where O2: From<O>, E2: From<E>, Self: Sized,

automatically converts the parser’s output and error values to another type, as long as they implement the From trait
source§

impl PartialEq for X509Error

source§

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

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> AsAny for T
where T: Any,

source§

fn as_any_ref(&self) -> &(dyn Any + 'static)

source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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<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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. 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, U> Upcast<T> for U
where T: UpcastFrom<U>,

source§

fn upcast(self) -> T

source§

impl<T, B> UpcastFrom<Counter<T, B>> for T

source§

fn upcast_from(value: Counter<T, B>) -> T

source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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> CustomEndpoint for T
where T: Display + Debug + Sync + Send + Any,