Crate ws
Available on crate features
http and ws only.Expand description
WebSocket (WS) support for rama (RFC 6455).
§Cancel safety
Reading messages is cancel-safe. AsyncWebSocket has no dedicated read
methods; messages arrive through its Stream implementation, and reading a
message via StreamExt::next follows that trait’s cancel-safety: if the
next() future is dropped before it resolves (for example, as a branch of
tokio::select! that another branch completes first), no message is lost.
The next poll resumes from the same position in the stream.
The Sink side (sending) does not carry a documented cancel-safety
guarantee.
§Rama
Crate used by the end-user rama crate and rama crate authors alike.
Learn more about rama:
- Github: https://github.com/plabayo/rama
- Book: https://ramaproxy.org/book/
Modules§
- handshake
- Utilities to aid in the handshake phase of establishing a WebSocket connection.
- protocol
- Generic WebSocket message stream.
- runtime
- Async runtime for Rama WebSockets
Structs§
- Async
WebSocket - A wrapper around an underlying raw stream which implements the WebSocket protocol.
- Utf8
Bytes - Utf8 payload.
Enums§
- Message
- An enum representing the various forms of a WebSocket message.
- Protocol
Error - Indicates the specific type/cause of a protocol error.