Enum Error 

#[non_exhaustive]
pub enum Error {
    Open(Error),
    ReadFile(Error),
    Read(Error),
    Key(Error),
    Empty,
    EmptyRoots(PathBuf),
    NoRoots,
    Fingerprint(FromHexError),
    FingerprintLength(usize),
    FingerprintWithRoots,
    AddRoot(Error),
    ClientAuth(Error),
    IncompleteClientAuth,
    CertKeyCountMismatch,
    NoCertSource,
    KeyMismatch {
        key: PathBuf,
        cert: PathBuf,
        source: Error,
    },
    Rustls(Error),
    ClientVerifier(VerifierBuilderError),
    Rcgen(Error),
    NoCryptoProvider,
}

Errors loading or generating TLS certificates and keys.

Shared by the client TLS config and the quinn/noq servers so each backend’s error type can compose it via #[from].

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Open(Error)

A certificate file couldn’t be opened, usually a bad path or permissions.

ReadFile(Error)

A certificate or key file was opened but couldn’t be read to the end.

Read(Error)

A file’s contents aren’t valid PEM certificates.

Key(Error)

A file’s contents aren’t a valid PEM private key.

Empty

A PEM file parsed cleanly but held no certificates.

EmptyRoots(PathBuf)

A root PEM file parsed cleanly but held no certificates, so it would trust nothing.

NoRoots

Nothing is configured that could ever verify a server certificate.

Fingerprint(FromHexError)

A configured fingerprint isn’t valid hex.

FingerprintLength(usize)

A configured fingerprint is valid hex but the wrong size for a SHA-256 digest.

FingerprintWithRoots

Fingerprint pinning was combined with CA roots. Pinning bypasses the chain, so one of the two would be silently ignored.

AddRoot(Error)

A root certificate parsed as PEM but rustls rejected it as a trust anchor.

ClientAuth(Error)

rustls rejected the mTLS client certificate and key, e.g. they don’t match.

IncompleteClientAuth

Only one half of the mTLS client identity was given; it needs both a cert and a key.

CertKeyCountMismatch

The server was given a different number of certificates than keys. They pair by index.

NoCertSource

The server has no certificate to serve: no cert/key pair and no hostnames to generate one for.

KeyMismatch

A server cert/key pair was paired up by index but the key isn’t the certificate’s.

Fields

key: PathBuf

Path of the private key file.

cert: PathBuf

Path of the certificate file it was paired with.

source: Error

Why rustls says the two don’t match.

Rustls(Error)

A rustls error with no more specific context, e.g. building a config.

ClientVerifier(VerifierBuilderError)

The mTLS client-certificate verifier couldn’t be built from the configured roots.

Rcgen(Error)

Generating a self-signed certificate failed.

NoCryptoProvider

The crate was built without a crypto provider, so no TLS is possible.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.