wynd 0.1.2

An attempt to make a websocket server in rust
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

# Wynd

## A user friendly WebSocket server written in Rust

"This is an experimental project, and its development may change over time."

Please star the repo if you like it, so that I know someone is using it.

## Table of Contents

- [Overview](#overview)
- [Goals](#goals)
- [Installation](#installation)
- [Examples](#basic-example)
- [Documentation](#documentation)
- [Changelog](#changelog)

---

## Overview

Wynd is a user friendly WebSocket server written in Rust.

## Goals

- Provide an intuitive and simple API like WS in javascript.
- Focus on developer experience first; performance optimizations will come later
- Prioritize ease of use over low-level control initially

---

## Installation

You can add `wynd` to your project using Cargo:

```sh
cargo add wynd tokio
```

Or manually add it to your `Cargo.toml`:

```toml
[dependencies]
wynd = "0.1.2"
tokio = { version = "1.44.0", features = ["full"] }
```

## Basic Example

```rust
use wynd::wynd::Server;

#[tokio::main]
async fn main() {
    let mut wynd = Server::new(8080);

    wynd.on_connection(|mut conn| {
        println!("Client connected");

        conn.on_message(|_event, conn| {
            let conn = conn.clone();

            tokio::spawn(async move {
                conn.send("hehe").await;
            });
        });
    });

    wynd.listen().await.unwrap();
}
```

<!-- View more basic examples in [Examples]() dir. - -->

View full blown code examples [here](https://github.com/Guru901/wynd-examples).

## Documentation

[Getting Started Guide](./docs/getting-started.md)

## Changelog

[View Changelog](./CHANGELOG.md)