stream-ws 0.1.1

A layer over WebSocket enables carrying byte stream, for both native and WebAssembly.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

# stream-ws

[![docs.rs](https://img.shields.io/docsrs/stream-ws)](https://docs.rs/crate/stream-ws/latest)
[![repo](https://img.shields.io/badge/repo-stream--ws-blue?logo=github)](https://github.com/idkidknow/stream-ws)
[![crates-io](https://img.shields.io/badge/crates--io-stream--ws-blue)](https://crates.io/crates/stream-ws)

A layer over WebSocket enables carrying byte stream, for both native and WebAssembly.

Providing methods able to wrap any WebSocket message stream implementation,
and impl [`AsyncRead`](https://docs.rs/futures-io/latest/futures_io/trait.AsyncRead.html),
[`AsyncBufRead`](https://docs.rs/futures-io/latest/futures_io/trait.AsyncBufRead.html)
and [`AsyncWrite`](https://docs.rs/futures-io/latest/futures_io/trait.AsyncWrite.html).

## Usage

run `cargo add stream-ws` to bring it into your crate.

Examples in [`examples/`](https://github.com/idkidknow/stream-ws/tree/main/examples).

### Tungstenite

With feature `tungstenite`.

For `WebSocketStream` in either crate [`tokio-tungstenite`](https://crates.io/crates/tokio-tungstenite)
or [`async-tungstenite`](https://crates.io/crates/async-tungstenite),
use

```rust
let stream = stream_ws::tungstenite::WsByteStream::new(inner)
```

### Gloo (for WebAssembly)

With feature `gloo`.

For [`WebSocket`](https://docs.rs/gloo-net/latest/gloo_net/websocket/futures/struct.WebSocket.html)
in crate [`gloo`](https://crates.io/crates/gloo)
use

```rust
let stream = stream_ws::gloo::WsByteStream::new(inner)
```

### Wrapping underlying stream of other WebSocket implementation

Your WebSocket implementation should have a struct `S` satisfying trait bound

```rust
Stream<Item = Result<Msg, E>> + Sink<Msg, Error = E> + Unpin
```

where `Msg` and `E`
are message and error type of the implementation.

Create a struct `Handler` and impl
[`WsMessageHandle`](https://docs.rs/stream-ws/latest/stream_ws/trait.WsMessageHandle.html),
which is easy, and then
call `Handler::wrap_stream(underlying_stream)`
 to get a [`WsByteStream`](https://docs.rs/stream-ws/latest/stream_ws/struct.WsByteStream.html).

## Crate features

- `tokio`: impl `tokio`'s `AsyncRead`, `AsyncBufRead` and `AsyncWrite` variants
- `tungstenite`: handlers for message and error type from crate `tungstenite`
- `gloo`: handlers for message and error type from crate `gloo`

License: MIT OR Apache-2.0