#byte #traits #reading #sequentially #cursor #size #prelude

seqbytes

Provides traits for reading bytes sequentially

2 releases

0.1.1 Mar 12, 2022
0.1.0 Mar 12, 2022

#2782 in Parser implementations

24 downloads per month

Apache-2.0

27KB
509 lines

seqbytes

Latest version Documentation License

The seqbytes crate provides the traits ESeqByteReader and SeqByteReader used for reading bytes sequentially. The SeqByteReader trait convert the bytes into the specified generic type, denoted U, which must implement SizedNumber. The trait SizedNumber represents a type which can be converted to and from bytes, with a fixed size in bytes.

The trait ESeqByteReader is used for reading bytes sequentially, converting to a type with a specific endianness. The type converted to must implement EndianNumber, which represents a type which can be converted to and from bytes with a specific endianness.

Implementations

The traits ESeqByteReader and SeqByteReader are implemented by default on types implementing Read + Seek.

Example

use seqbytes::prelude::*;
use std::io::Cursor;

let a = vec![69, 96, 255, 255, 0x68, 0x65, 0x6C, 0x6C, 0x6F];
let mut cursor = Cursor::new(a);

let num: i32 = cursor.shift().unwrap();
let s = &*cursor.shift_string(5).unwrap();

assert_eq!(num, -40891);
assert_eq!(*s, *"hello");

Usage

Add this to your Cargo.toml:

[dependencies]
seqbytes = "0.1.1"

Documentation

License

seqbytes is distributed under the Apache v2.0 License.

See LICENSE.md for more details.

No runtime deps