Expand description
A fully asynchronous implementation of RFC6455 (The WebSocket protocol). Complete with an optional implementation of RFC7692 (Compression Extensions For WebSocket).
§Features
- Implement your own own extensions using ratchet_ext.
- Per-message deflate with ratchet_deflate or enable with the
deflatefeature. - Split WebSocket with the
splitfeature.
§Error handling
Ratchet is strict over its implementation of The WebSocket protocol and as such any errors in
a session may result in the closure of the session when performing a send or receive operation;
it is possible to perform a liveliness check on a WebSocket by invoking the is_closed function.
If an error is encountered, then an attempt to close the session cleanly is performed and an
error is returned so it is clear that the connection may have been closed.
Possible errors that may be encountered during an upgraded session are protocol violations by the peer or an IO error.
Re-exports§
pub use ratchet_ext;
Structs§
- Close
Reason - A reason for closing the WebSocket connection.
- Error
- The errors that may occur during a WebSocket connection.
- Frame
Header - A frame’s header.
- Header
- Represents a parsed header.
- Header
Map - A set of HTTP headers
- Header
Value - Represents an HTTP header field value.
- NoExt
- An extension stub that does nothing.
- NoExt
Decoder - NoExt
Encoder - NoExt
Provider - An extension provider stub that will always succeed with
NoExt. - RsvBits
- A structure containing the bits that an extension may set high during a session.
- Subprotocol
Registry - A subprotocol registry that is used for negotiating a possible subprotocol to use for a connection.
- Upgraded
Client - A structure representing an upgraded WebSocket session and an optional subprotocol that was negotiated during the upgrade.
- Upgraded
Server - A structure representing an upgraded WebSocket session and an optional subprotocol that was negotiated during the upgrade.
- WebSocket
- An upgraded WebSocket stream.
- WebSocket
Client Builder - A builder to construct WebSocket clients.
- WebSocket
Config - A configuration for building a WebSocket.
- WebSocket
Response - A response to send to a client if the connection will not be upgraded.
- WebSocket
Server Builder - A builder to construct WebSocket servers.
- WebSocket
Upgrader - Represents a client connection that has been accepted and the upgrade request validated. This may be used to validate the request by a user and opt to either continue the upgrade or reject the connection - such as if the target path does not exist.
Enums§
- Close
Code - Additional implementation sources:
- Close
State - Denotes the current state of a WebSocket session.
- Error
Kind - A type of error represented.
- Http
Error - HTTP errors.
- Message
- A received WebSocket frame.
- Message
Type - A message type to send.
- OpCode
- A data code for a frame.
- Payload
Type - The type of a payload to send to a peer.
- Protocol
Error - WebSocket protocol errors.
- Role
- The role of a WebSocket.
Traits§
- Extension
- A negotiated WebSocket extension.
- Extension
Decoder - A per-message frame decoder.
- Extension
Encoder - A per-message frame encoder.
- Extension
Provider - A trait for negotiating an extension during a WebSocket handshake.
- Reunitable
Extension - A trait for permitting a matched encoder and decoder to be reunited into an extension.
- Splittable
Extension - A trait for permitting an extension to be split into its encoder and decoder halves. Allowing for a WebSocket to be split into its sender and receiver halves.
- TryInto
Request - A trait for creating a request from a type.
- WebSocket
Stream - A stream representing a WebSocket connection.
Functions§
- accept
- Execute a server handshake on the provided stream.
- accept_
with - Execute a server handshake on the provided stream. An attempt will be made to negotiate the extension and subprotocols provided.
- subscribe
- Execute a WebSocket client handshake on
stream, opting for no compression on messages and no subprotocol. - subscribe_
with - Execute a WebSocket client handshake on
stream, attempting to negotiate the extension and a subprotocol.