Enum soup::WebsocketCloseCode

#[non_exhaustive]
pub enum WebsocketCloseCode {
    Normal,
    GoingAway,
    ProtocolError,
    UnsupportedData,
    NoStatus,
    Abnormal,
    BadData,
    PolicyViolation,
    TooBig,
    NoExtension,
    ServerError,
    TlsHandshake,
}

Pre-defined close codes that can be passed to WebsocketConnection::close() or received from WebsocketConnection::close_code().

However, other codes are also allowed.

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.

Normal

a normal, non-error close

GoingAway

the client/server is going away

ProtocolError

a protocol error occurred

UnsupportedData

the endpoint received data of a type that it does not support.

NoStatus

reserved value indicating that no close code was present; must not be sent.

Abnormal

reserved value indicating that the connection was closed abnormally; must not be sent.

BadData

the endpoint received data that was invalid (eg, non-UTF-8 data in a text message).

PolicyViolation

generic error code indicating some sort of policy violation.

TooBig

the endpoint received a message that is too big to process.

NoExtension

the client is closing the connection because the server failed to negotiate a required extension.

ServerError

the server is closing the connection because it was unable to fulfill the request.

TlsHandshake

reserved value indicating that the TLS handshake failed; must not be sent.

Trait Implementations

impl Clone for WebsocketCloseCode

fn clone(&self) -> WebsocketCloseCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebsocketCloseCode

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

Formats the value using the given formatter.

impl From<WebsocketCloseCode> for Value

fn from(v: WebsocketCloseCode) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for WebsocketCloseCode

type Checker = GenericValueTypeChecker<WebsocketCloseCode>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for WebsocketCloseCode

type ParamSpec = ParamSpecEnum

type SetValue = WebsocketCloseCode

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: WebsocketCloseCode) -> ParamSpecEnumBuilder<'_, WebsocketCloseCode>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for WebsocketCloseCode

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 Ord for WebsocketCloseCode

fn cmp(&self, other: &WebsocketCloseCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for WebsocketCloseCode

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

fn partial_cmp(&self, other: &WebsocketCloseCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for WebsocketCloseCode

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for WebsocketCloseCode

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for WebsocketCloseCode

type Type = WebsocketCloseCode

Type to get the Type from.

impl Copy for WebsocketCloseCode

impl Eq for WebsocketCloseCode

impl StructuralPartialEq for WebsocketCloseCode