Enum actix_http::ws::CloseCode
source · pub enum CloseCode {
Normal,
Away,
Protocol,
Unsupported,
Abnormal,
Invalid,
Policy,
Size,
Extension,
Error,
Restart,
Again,
// some variants omitted
}
Expand description
Status code used to indicate why an endpoint is closing the WebSocket connection.
Variants§
Normal
Indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
Away
Indicates that an endpoint is “going away”, such as a server going down or a browser having navigated away from a page.
Protocol
Indicates that an endpoint is terminating the connection due to a protocol error.
Unsupported
Indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).
Abnormal
Indicates an abnormal closure. If the abnormal closure was due to an error, this close code
will not be used. Instead, the on_error
method of the handler will be called with
the error. However, if the connection is simply dropped, without an error, this close code
will be sent to the handler.
Invalid
Indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [RFC 3629] data within a text message).
Policy
Indicates that an endpoint is terminating the connection because it has received a message that violates its policy. This is a generic status code that can be returned when there is no other more suitable status code (e.g., Unsupported or Size) or if there is a need to hide specific details about the policy.
Size
Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
Extension
Indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn’t return them in the response message of the WebSocket handshake. The list of extensions that are needed should be given as the reason for closing. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead.
Error
Indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
Restart
Indicates that the server is restarting. A client may choose to reconnect, and if it does, it should use a randomized delay of 5-30 seconds between attempts.
Again
Indicates that the server is overloaded and the client should either connect to a different IP (when multiple targets exist), or reconnect to the same IP when a user has performed an action.
Trait Implementations§
source§impl From<CloseCode> for CloseReason
impl From<CloseCode> for CloseReason
source§impl PartialEq for CloseCode
impl PartialEq for CloseCode
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.