noalloc-slip-rs 0.2.1

A no-std SLIP (Serial Line Internet Protocol) encoder and decoder implementation.
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

# No-allocation SLIP

## Getting Started

This Rust crate provides a no-std SLIP (Serial Line Internet Protocol) encoder and decoder implementation. SLIP is a simple protocol for sending packets over serial lines.

### Usage

This library has to be used in conjunction with the [`noalloc-vec-rs`](https://github.com/jaudiger/noalloc-vec-rs) crate.

- Example of encoding a packet:

```rust
use noalloc_slip_rs::slip::{END_CHAR, SlipEncoder, SlipDecoder};
use noalloc_vec_rs::vec::Vec;

const MAX_LENGTH: usize = 12;

let mut packet = Vec::<u8, MAX_LENGTH>::from([0x00, 0x01, 0x02, 0x03]);
SlipEncoder::encode(&mut packet).unwrap();

assert_eq!(*packet, [END_CHAR, 0x00, 0x01, 0x02, 0x03, END_CHAR]);
```

- Example of decoding a packet:

```rust
use noalloc_slip_rs::slip::{END_CHAR, SlipEncoder, SlipDecoder};
use noalloc_vec_rs::vec::Vec;

const MAX_LENGTH: usize = 12;

let mut decoder = SlipDecoder::<MAX_LENGTH>::default();
decoder.insert(END_CHAR).unwrap();
decoder.insert(0x00).unwrap();
decoder.insert(END_CHAR).unwrap();

assert!(decoder.is_buffer_completed());
assert_eq!(decoder.get_buffer(), &[0x00]);
```