3 releases (breaking)

0.3.0 Mar 4, 2024
0.2.0 Jan 19, 2024
0.1.0 Dec 29, 2023

#326 in WebSocket

Download history 1/week @ 2024-11-20 8/week @ 2024-11-27 16/week @ 2024-12-04 75/week @ 2024-12-11 97/week @ 2024-12-18 47/week @ 2024-12-25 87/week @ 2025-01-01 155/week @ 2025-01-08 70/week @ 2025-01-15 27/week @ 2025-01-22 481/week @ 2025-01-29 195/week @ 2025-02-05 227/week @ 2025-02-12 244/week @ 2025-02-19 133/week @ 2025-02-26

856 downloads per month
Used in xitca-web

Apache-2.0

62KB
1K SLoC

an async websocket crate.

Features

  • common http types and streaming interface for easy integration.

Requirement

  • Rust 1.75
  • http and futures for http types and async streaming interaction[^1]

[^1]: see project Cargo.toml for dependency versioning.


lib.rs:

WebSocket protocol using high level API that operate over futures_core::Stream trait.

HTTP type

  • http crate types are used for input and output
  • support http/1.1 and http/2

Examples

use http::{header, Request, StatusCode};
use http_ws::handshake;

// an incoming http request.
let request = Request::get("/")
    .header(header::UPGRADE, header::HeaderValue::from_static("websocket"))
    .header(header::CONNECTION, header::HeaderValue::from_static("upgrade"))
    .header(header::SEC_WEBSOCKET_VERSION, header::HeaderValue::from_static("13"))
    .header(header::SEC_WEBSOCKET_KEY, header::HeaderValue::from_static("some_key"))
    .body(())
    .unwrap();

let method = request.method();
let headers = request.headers();

// handshake with request and return a response builder on success.
let response_builder = handshake(method, headers).unwrap();

// add body to builder and finalized it.
let response = response_builder.body(()).unwrap();

// response is valid response to websocket request.
assert_eq!(response.status(), StatusCode::SWITCHING_PROTOCOLS);

async HTTP body

Please reference [ws] function

Dependencies

~1.8–8MB
~61K SLoC