Crate ratchet_core

Ratchet’s core implementation. See the Ratchet crate for usage.

Structs

• CloseReason
  A reason for closing the WebSocket connection.
• Error
  The errors that may occur during a WebSocket connection.
• InvalidHeader
  An invalid header was received.
• NegotiatedExtension
• NoExt
  An extension stub that does nothing.
• NoExtDecoder
• NoExtEncoder
• NoExtProvider
  An extension provider stub that will always succeed with NoExt.
• ProtocolRegistry
  A subprotocol registry that is used for negotiating a possible subprotocol to use for a connection.
• UpgradedClient
  A structure representing an upgraded WebSocket session and an optional subprotocol that was negotiated during the upgrade.
• UpgradedServer
  A structure representing an upgraded WebSocket session and an optional subprotocol that was negotiated during the upgrade.
• WebSocket
  An upgraded WebSocket stream.
• WebSocketClientBuilder
  A builder to construct WebSocket clients.
• WebSocketConfig
  A configuration for building a WebSocket.
• WebSocketResponse
  A response to send to a client if the connection will not be upgraded.
• WebSocketServerBuilder
  A builder to construct WebSocket servers.
• WebSocketUpgrader
  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

• CloseCause
  The channel is closed
• CloseCode
  Additional implementation sources:
• CloseState
  Denotes the current state of a WebSocket session.
• ErrorKind
  A type of error represented.
• HttpError
  HTTP errors.
• Message
  A received WebSocket frame.
• MessageType
  A message type to send.
• PayloadType
  The type of a payload to send to a peer.
• ProtocolError
  WebSocket protocol errors.
• Role
  The role of a WebSocket.

Traits

• TryIntoRequest
  A trait for creating a request from a type.
• WebSocketStream
  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.