byteable_derive

Procedural derive macro for the byteable crate.

This crate provides the #[derive(Byteable)] macro. You almost certainly want to depend on byteable directly (which re-exports this macro via the derive feature) rather than adding byteable_derive as a direct dependency.

[dependencies]
byteable = "0.31"          # includes #[derive(Byteable)] by default

What #[derive(Byteable)] generates

Applying the macro to a type generates byte-serialization trait impls automatically. The exact traits depend on the type and attributes used:

Attributes

Struct / enum level

Field level

Examples

Fixed-size struct

use byteable::{Byteable, IntoByteArray, TryFromByteArray};

#[derive(Byteable)]
struct Point {
    x: f32,
    y: f32,
}

let p = Point { x: 1.0, y: 2.0 };
let bytes: [u8; 8] = p.into_byte_array();
let p2 = Point::try_from_byte_array(bytes).unwrap();
assert_eq!(p.x, p2.x);

Endianness control

use byteable::Byteable;

#[derive(Byteable)]
#[byteable(big_endian)]
struct NetworkHeader {
    magic: u32,
    #[byteable(little_endian)]  // field-level override
    payload_len: u16,
    version: u8,
}

Dynamic struct (io_only)

use byteable::{Byteable, Writable, Readable};
use byteable::io::{WriteValue, ReadValue};

#[derive(Byteable)]
#[byteable(io_only)]
struct Message {
    id: u32,
    body: String,
    tags: Vec<String>,
}

Unit enum

use byteable::{Byteable, IntoByteArray, TryFromByteArray};

#[derive(Byteable, Debug, PartialEq)]
enum Color { Red, Green, Blue }

// Auto-selected repr: u8 (3 variants fits in 1 byte)
assert_eq!(Color::BYTE_SIZE, 1);
let bytes = Color::Green.into_byte_array();
assert_eq!(Color::try_from_byte_array(bytes).unwrap(), Color::Green);

Field enum

use byteable::{Byteable, Readable, Writable};
use byteable::io::{WriteValue, ReadValue};

#[derive(Byteable, Debug, PartialEq)]
enum Shape {
    Circle { radius: f32 },
    Rect   { width: f32, height: f32 },
}

License

MIT — see LICENSE.