Enum rustls::Error

#[non_exhaustive]
pub enum Error {
    InappropriateMessage {
        expect_types: Vec<ContentType>,
        got_type: ContentType,
    },
    InappropriateHandshakeMessage {
        expect_types: Vec<HandshakeType>,
        got_type: HandshakeType,
    },
    InvalidMessage(InvalidMessage),
    NoCertificatesPresented,
    UnsupportedNameType,
    DecryptError,
    EncryptError,
    PeerIncompatible(PeerIncompatible),
    PeerMisbehaved(PeerMisbehaved),
    AlertReceived(AlertDescription),
    InvalidCertificate(CertificateError),
    InvalidCertRevocationList(CertRevocationListError),
    General(String),
    FailedToGetCurrentTime,
    FailedToGetRandomBytes,
    HandshakeNotComplete,
    PeerSentOversizedRecord,
    NoApplicationProtocol,
    BadMaxFragmentSize,
    Other(OtherError),
}

rustls reports protocol errors using this type.

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.

InappropriateMessage

We received a TLS message that isn’t valid right now. expect_types lists the message types we can expect right now. got_type is the type we found. This error is typically caused by a buggy TLS stack (the peer or this one), a broken network, or an attack.

Fields

expect_types: Vec<ContentType>

Which types we expected

got_type: ContentType

What type we received

InappropriateHandshakeMessage

We received a TLS handshake message that isn’t valid right now. expect_types lists the handshake message types we can expect right now. got_type is the type we found.

Fields

expect_types: Vec<HandshakeType>

Which handshake type we expected

got_type: HandshakeType

What handshake type we received

InvalidMessage(InvalidMessage)

The peer sent us a TLS message with invalid contents.

NoCertificatesPresented

The peer didn’t give us any certificates.

UnsupportedNameType

The certificate verifier doesn’t support the given type of name.

DecryptError

We couldn’t decrypt a message. This is invariably fatal.

EncryptError

We couldn’t encrypt a message because it was larger than the allowed message size. This should never happen if the application is using valid record sizes.

PeerIncompatible(PeerIncompatible)

The peer doesn’t support a protocol version/feature we require. The parameter gives a hint as to what version/feature it is.

PeerMisbehaved(PeerMisbehaved)

The peer deviated from the standard TLS protocol. The parameter gives a hint where.

AlertReceived(AlertDescription)

We received a fatal alert. This means the peer is unhappy.

InvalidCertificate(CertificateError)

We saw an invalid certificate.

The contained error is from the certificate validation trait implementation.

InvalidCertRevocationList(CertRevocationListError)

A provided certificate revocation list (CRL) was invalid.

General(String)

A catch-all error for unlikely errors.

FailedToGetCurrentTime

We failed to figure out what time it currently is.

FailedToGetRandomBytes

We failed to acquire random bytes from the system.

HandshakeNotComplete

This function doesn’t work until the TLS handshake is complete.

PeerSentOversizedRecord

The peer sent an oversized record/fragment.

NoApplicationProtocol

An incoming connection did not support any known application protocol.

BadMaxFragmentSize

The max_fragment_size value supplied in configuration was too small, or too large.

Other(OtherError)

Any other error.

This variant should only be used when the error is not better described by a more specific variant. For example, if a custom crypto provider returns a provider specific error.

Enums holding this variant will never compare equal to each other.

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

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<CertRevocationListError> for Error

fn from(e: CertRevocationListError) -> Self

Converts to this type from the input type.

impl From<CertificateError> for Error

fn from(e: CertificateError) -> Self

Converts to this type from the input type.

impl From<GetRandomFailed> for Error

fn from(_: GetRandomFailed) -> Self

Converts to this type from the input type.

impl From<InvalidMessage> for Error

fn from(e: InvalidMessage) -> Self

Converts to this type from the input type.

impl From<OtherError> for Error

fn from(value: OtherError) -> Self

Converts to this type from the input type.

impl From<PeerIncompatible> for Error

fn from(e: PeerIncompatible) -> Self

Converts to this type from the input type.

impl From<PeerMisbehaved> for Error

fn from(e: PeerMisbehaved) -> Self

Converts to this type from the input type.

impl From<SystemTimeError> for Error

fn from(_: SystemTimeError) -> Self

Converts to this type from the input type.

impl From<UnsupportedOperationError> for Error

fn from(value: UnsupportedOperationError) -> Self

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Error