Lightws

Released API docs

Lightweight websocket implement for stream transmission.

Features

High-level API

[role, endpoint, stream]

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); }

Low-level API

[frame, handshake]

```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 mut customheaders = HttpHeader::newstorage(); let request = Request::new(&mut custom_headers); let offset = request.encode(&mut buf).unwrap();

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

} ```