30 releases

0.8.0-pre6 Jan 1, 2024
0.8.0-pre5 Dec 15, 2023
0.8.0-pre1 Nov 4, 2023
0.8.0-alpha.9 Mar 30, 2024
0.2.0 Nov 19, 2020

#118 in Encoding

Download history 219470/week @ 2024-01-03 232344/week @ 2024-01-10 259745/week @ 2024-01-17 262720/week @ 2024-01-24 292446/week @ 2024-01-31 297276/week @ 2024-02-07 263898/week @ 2024-02-14 273754/week @ 2024-02-21 292442/week @ 2024-02-28 308968/week @ 2024-03-06 327896/week @ 2024-03-13 328122/week @ 2024-03-20 312532/week @ 2024-03-27 330979/week @ 2024-04-03 330609/week @ 2024-04-10 254969/week @ 2024-04-17

1,289,282 downloads per month
Used in 408 crates (62 directly)

MIT license

38KB
646 lines

bytecheck   Latest Version License

bytecheck is a type validation framework for Rust.

bytecheck in action

use bytecheck::{CheckBytes, check_bytes, rancor::Failure};

#[derive(CheckBytes, Debug)]
#[repr(C)]
struct Test {
    a: u32,
    b: char,
    c: bool,
}

#[repr(C, align(4))]
struct Aligned<const N: usize>([u8; N]);

macro_rules! bytes {
    ($($byte:literal,)*) => {
        (&Aligned([$($byte,)*]).0 as &[u8]).as_ptr()
    };
    ($($byte:literal),*) => {
        bytes!($($byte,)*)
    };
}

// In this example, the architecture is assumed to be little-endian
#[cfg(target_endian = "little")]
unsafe {
    // These are valid bytes for a `Test`
    check_bytes::<Test, Failure>(
        bytes![
            0u8, 0u8, 0u8, 0u8,
            0x78u8, 0u8, 0u8, 0u8,
            1u8, 255u8, 255u8, 255u8,
        ].cast()
    ).unwrap();

    // Changing the bytes for the u32 is OK, any bytes are a valid u32
    check_bytes::<Test, Failure>(
        bytes![
            42u8, 16u8, 20u8, 3u8,
            0x78u8, 0u8, 0u8, 0u8,
            1u8, 255u8, 255u8, 255u8,
        ].cast()
    ).unwrap();

    // Characters outside the valid ranges are invalid
    check_bytes::<Test, Failure>(
        bytes![
            0u8, 0u8, 0u8, 0u8,
            0x00u8, 0xd8u8, 0u8, 0u8,
            1u8, 255u8, 255u8, 255u8,
        ].cast()
    ).unwrap_err();
    check_bytes::<Test, Failure>(
        bytes![
            0u8, 0u8, 0u8, 0u8,
            0x00u8, 0x00u8, 0x11u8, 0u8,
            1u8, 255u8, 255u8, 255u8,
        ].cast()
    ).unwrap_err();

    // 0 is a valid boolean value (false) but 2 is not
    check_bytes::<Test, Failure>(
        bytes![
            0u8, 0u8, 0u8, 0u8,
            0x78u8, 0u8, 0u8, 0u8,
            0u8, 255u8, 255u8, 255u8,
        ].cast()
    ).unwrap();
    check_bytes::<Test, Failure>(
        bytes![
            0u8, 0u8, 0u8, 0u8,
            0x78u8, 0u8, 0u8, 0u8,
            2u8, 255u8, 255u8, 255u8,
        ].cast()
    ).unwrap_err();
}

Dependencies

~0.5–1MB
~22K SLoC