Enum rocket::mtls::Error

#[non_exhaustive]
pub enum Error {
    Empty,
    NoSubject,
    NonCriticalSubjectAlt,
    Parse(X509Error),
    Incomplete(Option<NonZero<usize>>),
    Trailing(usize),
}

Available on crate feature mtls only.

An error returned by the Certificate request guard.

To retrieve this error in a handler, use an mtls::Result<Certificate> guard type:

use rocket::mtls::{self, Certificate};

#[get("/auth")]
fn auth(cert: mtls::Result<Certificate<'_>>) {
    match cert {
        Ok(cert) => { /* do something with the client cert */ },
        Err(e) => { /* do something with the error */ },
    }
}

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.

Empty

The certificate chain presented by the client had no certificates.

NoSubject

The certificate contained neither a subject nor a subjectAlt extension.

NonCriticalSubjectAlt

There is no subject and the subjectAlt is not marked as critical.

Parse(X509Error)

An error occurred while parsing the certificate.

Incomplete(Option<NonZero<usize>>)

The certificate parsed partially but is incomplete.

If Some(n), then n more bytes were expected. Otherwise, the number of expected bytes is unknown.

Trailing(usize)

The certificate contained .0 bytes of trailing data.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

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<Err<X509Error>> for Error

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

Converts to this type from the input type.