Skip to main content

CloseCode

fastapi_http::websocket

Enum CloseCode

pub enum CloseCode {
Show 15 variants    Normal,
    GoingAway,
    ProtocolError,
    UnsupportedData,
    NoStatusReceived,
    AbnormalClosure,
    InvalidPayload,
    PolicyViolation,
    MessageTooBig,
    MandatoryExtension,
    InternalError,
    ServiceRestart,
    TryAgainLater,
    BadGateway,
    Application(u16),
}

Expand description

WebSocket close status code (RFC 6455 §7.4.1).

Variants§

Normal

Normal closure (1000).

GoingAway

Endpoint going away (1001).

ProtocolError

Protocol error (1002).

UnsupportedData

Unsupported data type (1003).

NoStatusReceived

No status code present (1005) — must not be sent in a frame.

AbnormalClosure

Abnormal closure (1006) — must not be sent in a frame.

InvalidPayload

Invalid payload data (1007).

PolicyViolation

Policy violation (1008).

MessageTooBig

Message too big (1009).

MandatoryExtension

Missing expected extension (1010).

InternalError

Internal server error (1011).

ServiceRestart

Service restart (1012).

TryAgainLater

Try again later (1013).

BadGateway

Bad gateway (1014).

Application(u16)

Application-defined or registered code in the 3000-4999 range.

Implementations§

impl CloseCode

pub fn to_u16(self) -> u16

Convert to the 2-byte wire representation.

pub fn from_u16(code: u16) -> Self

Parse from a 2-byte wire value.

Trait Implementations§

impl Clone for CloseCode

fn clone(&self) -> CloseCode

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for CloseCode

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

Formats the value using the given formatter. Read more

impl Display for CloseCode

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

Formats the value using the given formatter. Read more

impl PartialEq for CloseCode

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

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

1.0.0 · Source§

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 Copy for CloseCode

impl Eq for CloseCode

impl StructuralPartialEq for CloseCode

Auto Trait Implementations§

impl Freeze for CloseCode

impl RefUnwindSafe for CloseCode

impl Send for CloseCode

impl Sync for CloseCode

impl Unpin for CloseCode

impl UnwindSafe for CloseCode

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> ResponseProduces<T> for T