Struct CheckpointWriter 

pub struct CheckpointWriter {
    pub path: PathBuf,
    pub compress: bool,
}

Writes simulation snapshots to a binary checkpoint file.

Call methods in order:

1. write_header(CheckpointWriter::write_header)
2. write_positions (optional)
3. write_velocities (optional)
4. Any number of write_scalars / write_integers
5. finalize

Fields

path: PathBuf

Destination file path.

compress: bool

Whether to Zstandard-compress the file after finalize.

Implementations

impl CheckpointWriter

pub fn new(path: impl Into<PathBuf>) -> Self

Create a new CheckpointWriter targeting path.

pub fn with_compress(self, compress: bool) -> Self

Enable or disable Zstandard compression of the finalised file.

pub fn write_header(&self, meta: &CheckpointMetadata) -> Result<()>

Write the file header and metadata record.

Creates (or truncates) the file and writes the magic number, format version, and serialized metadata.

pub fn write_positions(&self, pos: &[[f64; 3]]) -> Result<()>

Append a positions block ([[f64; 3\]]) to the checkpoint file.

Each position is written as three little-endian f64 values.

pub fn write_velocities(&self, vel: &[[f64; 3]]) -> Result<()>

Append a velocities block ([[f64; 3\]]) to the checkpoint file.

pub fn write_scalars(&self, name: &str, data: &[f64]) -> Result<()>

Append a named scalar (f64) array to the checkpoint file.

pub fn write_integers(&self, name: &str, data: &[i32]) -> Result<()>

Append a named integer (i32) array to the checkpoint file.

pub fn finalize(&self) -> Result<()>

Write the footer record containing the file checksum, then optionally compress the entire file in-place with Zstandard.

Reads back the entire file written so far, computes the checksum, and appends a footer tag followed by the 4-byte checksum. If with_compress was set to true, the finalized file is replaced with its Zstandard-compressed equivalent.

Trait Implementations

impl Clone for CheckpointWriter

fn clone(&self) -> CheckpointWriter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckpointWriter

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

Formats the value using the given formatter.