https://github.com/zephyrchien/lightws

Lightweight websocket implement for stream transmission.
https://github.com/zephyrchien/lightws

network rust websocket

Last synced: 2 months ago
JSON representation

Lightweight websocket implement for stream transmission.

• Host: GitHub
• URL: https://github.com/zephyrchien/lightws
• Owner: zephyrchien
• License: mit
• Created: 2022-03-17T16:29:15.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-08-02T17:39:52.000Z (11 months ago)
• Last Synced: 2026-01-02T10:55:57.700Z (6 months ago)
• Topics: network, rust, websocket
• Language: Rust
• Homepage:
• Size: 153 KB
• Stars: 31
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Lightws

![Lightws](https://github.com/zephyrchien/lightws/workflows/ci/badge.svg)

![Lightws](https://github.com/zephyrchien/lightws/workflows/build/badge.svg)

[![Released API docs](https://docs.rs/lightws/badge.svg)](https://docs.rs/lightws)

[![crates.io](https://img.shields.io/crates/v/lightws.svg)](https://crates.io/crates/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::connect(tcp, buf, host, path)?;

    // read some data

    stream.read(&mut buf)?;

    // write some data

    stream.write(&buf)?;

}

```

Async:

```rust

{

    // handshake

    let stream = Endpoint::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();

}

```