tinyudp 0.5.0

A tiny abstraction for UDP.
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

# tinyudp [![Test](https://github.com/vikpe/tinyudp/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/vikpe/tinyudp/actions/workflows/test.yml) [![crates](https://img.shields.io/crates/v/tinyudp)](https://crates.io/crates/tinyudp) [![docs.rs](https://img.shields.io/docsrs/tinyudp)](https://docs.rs/tinyudp/)

> A tiny abstraction for UDP in Rust

## Overview

```rust
tinyudp::send(address: impl ToSocketAddrs, message: &[u8]) -> Result<usize>
tinyudp::read(address: impl ToSocketAddrs, options: &ReadOptions) -> Result<Vec<u8>>
tinyudp::send_and_read(address: impl ToSocketAddrs, message: &[u8], read_options: &ReadOptions) -> Result<Vec<u8>>

struct ReadOptions {
    pub timeout: Option<Duration>,
    pub buffer_size: usize,
}
```

## Usage

### Send

```rust
tinyudp::send("quake.se:28000", &b"hello")?;
```

### Read

```rust
let options = tinyudp::ReadOptions{
    timeout: Some(Duration::from_secs(1)),
    buffer_size: 8 * 1024,
};
let response = tinyudp::read("quake.se:28000", &options)?;
```

### Send and read

```rust
let options = tinyudp::ReadOptions{
    timeout: Some(Duration::from_secs(1)),
    buffer_size: 8 * 1024,
};

match tinyudp::send_and_read("quake.se:28000", &b"hello", &options) {
    Ok(response) => {
        println!("response: {:?}", response);
    },
    Err(e) => {
        println!("error: {:?}", e);
    },
};
```