Struct BinaryHeader 

pub struct BinaryHeader {
    pub magic: [u8; 4],
    pub version: u32,
    pub n_particles: u64,
    pub n_frames: u64,
    pub dt: f64,
}

Binary file header for OxiPhysics trajectory files.

Layout (little-endian):

• 4 bytes : magic
• 4 bytes : version (u32)
• 8 bytes : n_particles (u64)
• 8 bytes : n_frames (u64)
• 8 bytes : dt (f64)

Fields

magic: [u8; 4]

Magic bytes — must equal OXIPHY_MAGIC.

version: u32

File format version.

n_particles: u64

Number of particles per frame.

n_frames: u64

Number of frames stored.

dt: f64

Integration time step (seconds).

Implementations

impl BinaryHeader

pub const SIZE: usize = 32

Byte size of the serialised header.

pub fn new(n_particles: u64, n_frames: u64, dt: f64) -> Self

Create a new header with the given parameters.

pub fn validate(&self) -> bool

Validate that the magic bytes and version are recognised.

Returns true when the header looks valid.

pub fn write(&self, buf: &mut Vec<u8>)

Serialise this header into buf (appends bytes).

pub fn read(buf: &[u8]) -> Option<Self>

Deserialise a header from a byte slice.

Returns None if buf is shorter than BinaryHeader::SIZE.

Trait Implementations

impl Clone for BinaryHeader

fn clone(&self) -> BinaryHeader

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BinaryHeader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BinaryHeader

fn eq(&self, other: &BinaryHeader) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BinaryHeader