websock 0.3.0

WebSocket library for native and WebAssembly
Documentation

websock Crates.io License

A minimal WebSocket library for native and WebAssembly.

Workspace crates

  • websock: top-level facade that selects native (websock-tungstenite) or browser (websock-wasm) transport.
  • websock-proto: shared protocol types and error model.
  • websock-tungstenite: native transport powered by tokio + tungstenite (optional TLS via rustls).
  • websock-wasm: browser transport based on the WebSocket API.
  • websock-mux: top-level facade for multiplexed streams over WebSocket.
  • websock-mux-proto: frame and varint primitives for the multiplexing layer.
  • websock-tungstenite-mux: native multiplexed transport.
  • websock-wasm-mux: browser multiplexed transport.
  • websock-wasm-demo: small browser demo application.

Quick start

[dependencies]
websock = "0.3"

API documentation is available on docs.rs.

If you need transport-specific features, depend on one of the transport crates directly.

Native

See examples.

WebAssembly

The websock-wasm-demo crate includes a small browser app that connects to an echo server.

Benchmarking

Criterion benchmarks are available for websock-mux-proto.

cargo bench -p websock-mux-proto