5 releases

0.2.2 Jul 26, 2021
0.2.1 Feb 28, 2021
0.2.0 Aug 17, 2020
0.1.1 Jun 13, 2020
0.1.0 Jun 12, 2020

#80 in #endian

Download history 55/week @ 2024-04-12 36/week @ 2024-04-19 36/week @ 2024-04-26 39/week @ 2024-05-03 20/week @ 2024-05-10 21/week @ 2024-05-17 15/week @ 2024-05-24 15/week @ 2024-05-31 71/week @ 2024-06-07 107/week @ 2024-06-14 40/week @ 2024-06-21 7/week @ 2024-06-28 4/week @ 2024-07-05 10/week @ 2024-07-12 21/week @ 2024-07-19 54/week @ 2024-07-26

89 downloads per month
Used in endiannezz

MIT license

12KB
279 lines

endiannezz

Build Status Latest Version Documentation

Zero dependencies library for I/O endianness on high-level

Installing

[dependencies]
endiannezz = "0.6"

Using #[derive(Io)]

use endiannezz::Io;
use std::io::Result;

#[derive(Io)]
#[endian(big)]
struct ParseMe {
    works: bool,
    data: u32,
    #[endian(little)]
    extra: i16,
}

fn main() -> Result<()> {
    let s1 = ParseMe {
        works: true,
        data: 10,
        extra: 20,
    };

    //writing struct as bytes into vec
    let mut vec = Vec::new();
    s1.write(&mut vec)?;

    let mut slice = vec.as_slice();
    #[rustfmt::skip]
    assert_eq!(slice, &[
        1, //bool as byte
        0, 0, 0, 10, //u32 in big-endian (because big-endian is set on top place struct as default)
        20, 0, //i16 in little-endian (overriding default)
    ]);

    //reading struct from bytes
    let _s2 = ParseMe::read(&mut slice)?;

    Ok(())
}

Simple example

use endiannezz::ext::{EndianReader, EndianWriter};
use endiannezz::{BigEndian, LittleEndian, NativeEndian};
use std::io::Result;

fn main() -> Result<()> {
    let mut vec = Vec::new();

    vec.try_write::<LittleEndian, i32>(1)?;
    vec.try_write::<BigEndian, _>(2)?;
    vec.try_write::<NativeEndian, _>(3_u16)?;

    let mut slice = vec.as_slice();

    slice.try_read::<LittleEndian, i32>()?;
    let _num32: i32 = slice.try_read::<BigEndian, _>()?;
    let _num16: u16 = slice.try_read::<NativeEndian, _>()?;

    Ok(())
}

Dependencies

~1.5MB
~35K SLoC