Lightws

Lightweight websocket implement for stream transmission.

Features

• Avoid heap allocation.
• Avoid buffering frame payload.
• Use vectored-io if available.
• Transparent Read/Write over the underlying IO source.

High-level API

[role, endpoint, stream]

Std:

rust { // handshake let stream = Endpoint<TcpStream, Client>::connect(tcp, buf, host, path)?; // read some data stream.read(&mut buf)?; // write some data stream.write(&buf)?; }

Async:

rust { // handshake let stream = Endpoint<TcpStream, Client>::connect_async(tcp, buf, host, path).await?; // read some data stream.read(&mut buf).await?; // write some data stream.write(&buf).await?; }

Low-level API

[frame, handshake]

Frame:

```rust { // encode a frame head let head = FrameHead::new(...); let offset = unsafe { head.encode_unchecked(&mut buf); };

// decode a frame head
let (head, offset) = FrameHead::decode(&buf).unwrap();

} ```

Handshake:

```rust { // make a client handshake request let request = Request::new(b"/ws", b"example.com", "sec-key.."); let offset = request.encode(&mut buf).unwrap();

// parse a server handshake response
let mut custom_headers = HttpHeader::new_storage();
let mut response = Response::new_storage(&mut custom_headers);
let offset = response.decode(&buf).unwrap();

} ```