async-serial 0.1.0

Lightweight async serial port adapter for async-io + serial
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

# async-serial

Lightweight async serial port adapter — bridges [`serial`] with [`async-io`].

[![Crates.io](https://img.shields.io/crates/v/async-serial)](https://crates.io/crates/async-serial)
[![License](https://img.shields.io/crates/l/async-serial)](https://github.com/ZXY595/async-serial#license)

## Quickstart

```rust
use async_serial::{open, SerialPort, SerialPortSettings}

let mut port = open("/dev/ttyUSB0")?;
port.reconfigure(&|settings| {
    settings.set_baud_rate(serial::Baud9600)?;
    Ok(())
})?;

// Async read — won't block the executor
let mut buf = [0u8; 256];
let n = port.read(&mut buf).await?;
```

## How It Works

`serial::SystemPort` implements `Read` + `Write` but those are blocking calls. `async-io` provides an `Async<T>` wrapper that makes any `IoSafe + AsFd` type non-blocking via the reactor. This crate provides the missing `IoSafe` and `AsFd` impls in a small newtype.

## API

- **`open(path)`** — opens a serial port and returns `Async<SystemPort>`
- **`SystemPort::from_serial(port)`** — wraps an existing `serial::SystemPort`
- **`Deref<Target = serial::SystemPort>`** — transparent access to all serial methods

## License

MIT OR Apache-2.0