29 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

#26 in #repr

Download history 258051/week @ 2024-01-21 288377/week @ 2024-01-28 293847/week @ 2024-02-04 280290/week @ 2024-02-11 260620/week @ 2024-02-18 287548/week @ 2024-02-25 300733/week @ 2024-03-03 317796/week @ 2024-03-10 333934/week @ 2024-03-17 325571/week @ 2024-03-24 321509/week @ 2024-03-31 326136/week @ 2024-04-07 318816/week @ 2024-04-14 316214/week @ 2024-04-21 267954/week @ 2024-04-28 285244/week @ 2024-05-05

1,212,730 downloads per month
Used in 414 crates (via bytecheck)

MIT license

31KB
688 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();
}

lib.rs:

Procedural macros for bytecheck.

Dependencies

~270–720KB
~17K SLoC