nt_client 0.1.0

A blazingly fast NetworkTables 4.1 client
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

# nt_client
A blazingly fast [WPI NetworkTables 4.1](https://github.com/wpilibsuite/allwpilib/blob/main/ntcore/doc/networktables4.adoc) client, written in Rust.

This is meant to be used within coprocessors that can send and receive data from the robot.

**This is still a pre-1.0.0 release! Expect things to not work correctly and breaking changes until a full 1.0.0 release is available!**

## 1.0.0 Release Checklist
- [x] Connecting to server
- [x] Subscribing to a topic
- [x] Publishing to a topic
- [ ] 100% documentation coverage
- [ ] Proper logging (instead of println!)
- [ ] Examples
- [ ] Better error handling (less `.expect`)
- [ ] Reconnections
- [ ] Caching

## Installation
Add the following dependency to your `Cargo.toml`
```toml
nt_client = "0.1.0"
```
Or run the following command in your project root
```
cargo add nt_client
```
## Example
A basic subscriber that prints changes to `stdout`

```rust
use nt_client::{Client, NewClientOptions, NTAddr};

#[tokio::main]
async fn main() {
    let options = NewClientOptions { addr: NTAddr::Local, ..Default::default() };
    let client = Client::new(options);

    let thing_topic = client.topic("/thing");
    tokio::spawn(async move {
        let mut sub = thing_topic.subscribe::<String>(Default::default())
            .await
            .expect("websocket connection closed!");

        while let Ok(recv) = sub.recv().await {
            println!("topic updated: '{recv}'")
        }
    });

    client.connect().await.unwrap();
});
```