hdlc

HDLC Framing Description

Only frames the data. Rust implementation of a High-level Data Link Control (HDLC) library with support of the IEEE standard.

• Crate
• Documentation
• Usage
• License

Usage

Add hdlc to Cargo.toml

toml [dependencies] hdlc = "^0.2.5"

or

toml [dependencies.hdlc] git = "https://github.com/CLomanno/hdlc"

Add this to crate root

rust extern crate hdlc;

Encode packet

```rust extern crate hdlc; use hdlc::{SpecialChars, encode};

// Set up your vector of bytes and generate your Special Characters let msg: Vec = vec![0x01, 0x50, 0x00, 0x00, 0x00, 0x05, 0x80, 0x09]; let cmp: Vec = vec![0x7E, 0x01, 0x50, 0x00, 0x00, 0x00, 0x05, 0x80, 0x09, 0x7E];

// Encode your message let result = encode(&msg, SpecialChars::default());

assert!(result.isok()); asserteq!(result.unwrap(), cmp); ```

Custom Special Characters

```rust extern crate hdlc; use hdlc::{SpecialChars, encode};

// Set up your vector of bytes and generate your Special Characters let msg: Vec = vec![0x01, 0x7E, 0x70, 0x50, 0x00, 0x05, 0x80, 0x09]; let cmp: Vec = vec![0x71, 0x01, 0x7E, 0x70, 0x50, 0x50, 0x00, 0x05, 0x80, 0x09, 0x71]; let chars = SpecialChars::new(0x71, 0x70, 0x51, 0x50);

// Encode your message let result = encode(&msg, chars);

assert!(result.isok()); asserteq!(result.unwrap(), cmp) ```

Decode packet

```rust extern crate hdlc; use hdlc::{SpecialChars, decode};

// Set up your vector of bytes and generate your Special Characters let msg: Vec = vec![ chars.fend, 0x01, 0x50, 0x00, 0x00, 0x00, 0x05, 0x80, 0x09, chars.fend, ]; let cmp: Vec = vec![0x01, 0x50, 0x00, 0x00, 0x00, 0x05, 0x80, 0x09];

// Decode your message let result = decode(&msg, chars);

assert!(result.isok()); asserteq!(result.unwrap(), cmp); ```

Decode slice packet

```rust extern crate hdlc; use hdlc::{SpecialChars, decode_slice};

// Set up your mutable slice of bytes and generate your Special Characters let chars = SpecialChars::default(); let mut msg = [ chars.fend, 0x01, 0x50, 0x00, 0x00, 0x00, 0x05, 0x80, 0x09, chars.fend, ]; let cmp = [0x01, 0x50, 0x00, 0x00, 0x00, 0x05, 0x80, 0x09];

// Decode your slice let result = decode_slice(&mut msg, chars);

assert!(result.isok()); asserteq!(result.unwrap(), cmp); ```

Benchmark

Bencher is currently not available in Rust stable releases.

cargo bench with 2.4 GHz Intel Xeon E5 results ~430MB/s throughput.

```rust cargo bench Running target/release/deps/bench-bb5601191c448c8f

benchencodemegabyte time: [2.2503 ms 2.2656 ms 2.2818 ms] benchdecodemegabyte time: [1.7752 ms 1.7939 ms 1.8161 ms] benchencodespecialcharsmegabyte time: [4.3846 ms 4.4090 ms 4.4348 ms] benchdecodespecialchars2_megabytes time: [1.7868 ms 1.7980 ms 1.8108 ms]

test result: ok. 0 passed; 0 failed; 0 ignored; 4 measured; 0 filtered out ```

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.