Struct AlertDescription 

pub struct AlertDescription(pub u8);

The AlertDescription TLS protocol enum. Values in this enum are taken from the various RFCs covering TLS, and are listed by IANA.

Protocol enumerations in rustls are represented with a struct, which contains the numeric value used on the wire (in this case, u8). Each known value has a named const item on this type – this can be used in a match arm or to access the numeric value.

If a known value does not exist for a value you need, you can simply create it locally:

pub const MyValue: AlertDescription = AlertDescription(123);

The Debug impl for this type also looks up and pretty-prints known named items. Unknown values are formatted in hexadecimal.

Tuple Fields

0: u8

Implementations

impl AlertDescription

pub const CloseNotify: Self

pub const UnexpectedMessage: Self

pub const BadRecordMac: Self

pub const DecryptionFailed: Self

pub const RecordOverflow: Self

pub const DecompressionFailure: Self

pub const HandshakeFailure: Self

pub const NoCertificate: Self

pub const BadCertificate: Self

pub const UnsupportedCertificate: Self

pub const CertificateRevoked: Self

pub const CertificateExpired: Self

pub const CertificateUnknown: Self

pub const IllegalParameter: Self

pub const UnknownCa: Self

pub const AccessDenied: Self

pub const DecodeError: Self

pub const DecryptError: Self

pub const ExportRestriction: Self

pub const ProtocolVersion: Self

pub const InsufficientSecurity: Self

pub const InternalError: Self

pub const InappropriateFallback: Self

pub const UserCanceled: Self

pub const NoRenegotiation: Self

pub const MissingExtension: Self

pub const UnsupportedExtension: Self

pub const CertificateUnobtainable: Self

pub const UnrecognizedName: Self

pub const BadCertificateStatusResponse: Self

pub const BadCertificateHashValue: Self

pub const UnknownPskIdentity: Self

pub const CertificateRequired: Self

pub const NoApplicationProtocol: Self

pub const EncryptedClientHelloRequired: Self

pub fn to_array(self) -> [u8; 1]

Encode the value as a big-endian byte array.

Trait Implementations

impl Clone for AlertDescription

fn clone(&self) -> AlertDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlertDescription

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

Formats the value using the given formatter.

impl Display for AlertDescription

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

Formats the value using the given formatter.

impl From<&CertificateError> for AlertDescription

fn from(e: &CertificateError) -> Self

Converts to this type from the input type.

impl From<AlertDescription> for u8

fn from(x: AlertDescription) -> Self

Converts to this type from the input type.

impl From<InvalidMessage> for AlertDescription

fn from(e: InvalidMessage) -> Self

Converts to this type from the input type.

impl From<PeerIncompatible> for AlertDescription

fn from(e: PeerIncompatible) -> Self

Converts to this type from the input type.

impl From<PeerMisbehaved> for AlertDescription

fn from(e: PeerMisbehaved) -> Self

Converts to this type from the input type.

impl From<u8> for AlertDescription

fn from(x: u8) -> Self

Converts to this type from the input type.

impl Hash for AlertDescription

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AlertDescription

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&Error> for AlertDescription

Determine which alert should be sent for a given error.

If this mapping fails, no alert is sent.

type Error = ()

The type returned in the event of a conversion error.

fn try_from(error: &Error) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for AlertDescription

impl Eq for AlertDescription

impl StructuralPartialEq for AlertDescription