Enum CloseReason 

#[non_exhaustive]
pub enum CloseReason {
    CertificateRotated,
    CertificateRevoked,
    NoValidCertificate,
    InternalError,
    CertificateNotRecognized,
    ServiceDeactivated,
    ServiceNotApproved,
    ServiceNotFound,
    EnrollmentTimeout,
    RateLimitExceeded,
    ProtocolError,
    Superseded,
    Unknown(String),
}

Reason included in a WebSocket close frame by the controller.

Known variants map 1:1 to the wire strings sent in close frames. Unknown provides forward compatibility for strings not yet recognized by the receiver.

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.

CertificateRotated

The service’s TLS certificate was rotated by the controller.

CertificateRevoked

The service’s TLS certificate was revoked.

NoValidCertificate

No valid certificate was presented during the TLS handshake.

InternalError

An internal server error occurred.

CertificateNotRecognized

The presented certificate is not recognized by the controller.

ServiceDeactivated

The service has been deactivated by an administrator.

ServiceNotApproved

The service has not been approved yet.

ServiceNotFound

The service was not found in the controller’s database.

EnrollmentTimeout

The enrollment handshake timed out.

RateLimitExceeded

The service exceeded the connection rate limit.

ProtocolError

The service sent an unexpected or malformed protocol message.

Used when the service violates the expected message sequence, for example by sending a message other than Register as the first frame after authentication completes.

Superseded

A newer connection from the same service superseded this one.

Unknown(String)

A close reason string not recognized by this build.

Provides forward compatibility: a newer controller may send reasons that an older service does not yet know about.

Implementations

impl CloseReason

pub fn as_str(&self) -> &str

Returns the wire-format string for this close reason.

Trait Implementations

impl Clone for CloseReason

fn clone(&self) -> CloseReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloseReason

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

Formats the value using the given formatter.

impl Display for CloseReason

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

Formats the value using the given formatter.

impl FromStr for CloseReason

type Err = ParseCloseReasonError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for CloseReason

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

impl StructuralPartialEq for CloseReason