34 releases

0.8.1 Feb 8, 2025
0.8.0 Sep 11, 2024
0.8.0-pre6 Jan 1, 2024
0.8.0-pre5 Dec 15, 2023
0.2.0 Nov 19, 2020

#558 in #validation

Download history 370448/week @ 2024-11-17 323196/week @ 2024-11-24 388346/week @ 2024-12-01 383179/week @ 2024-12-08 360902/week @ 2024-12-15 196376/week @ 2024-12-22 242504/week @ 2024-12-29 526483/week @ 2025-01-05 575252/week @ 2025-01-12 494995/week @ 2025-01-19 505103/week @ 2025-01-26 540398/week @ 2025-02-02 550519/week @ 2025-02-09 568500/week @ 2025-02-16 642098/week @ 2025-02-23 616025/week @ 2025-03-02

2,410,413 downloads per month
Used in 676 crates (via bytecheck)

MIT license

35KB
715 lines

bytecheck

crates.io badge docs badge license badge

bytecheck is a memory validation framework for Rust.

Documentation

Example

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

~190–620KB
~15K SLoC