Struct ConFrameWriter 

pub struct ConFrameWriter<W: Write> { /* private fields */ }

A writer that can serialize and write ConFrame objects to any output stream.

This struct encapsulates a writer (like a file) and provides a high-level API for writing simulation frames in the .con format.

Example

let mut writer = ConFrameWriter::from_path("output.con").unwrap();
writer.extend(frames.iter()).unwrap();

Implementations

impl<W: Write> ConFrameWriter<W>

pub fn new(writer: W) -> Self

Creates a new ConFrameWriter that wraps a given writer.

Arguments

• writer - Any type that implements std::io::Write, e.g., a File.

pub fn with_precision(writer: W, precision: usize) -> Self

Creates a new ConFrameWriter with a custom floating-point precision.

Arguments

• writer - Any type that implements std::io::Write.
• precision - Number of decimal places for floating-point output.

pub fn with_float_format(writer: W, float_format: FloatFormat) -> Self

Creates a writer with an explicit numeric text representation.

FloatFormat::RoundTrip retains small forces and coordinates exactly. Metadata floats use the JSON serializer independently of this setting.

pub fn canonical(self, on: bool) -> Self

Opt-in canonical serialization: BTree-ordered metadata keys in JSON, fixed section order, stable float precision (default 6). Use for corpus materialization and content-stable hashes; not required for on-disk fidelity of spans preserved from next_with_raw_span.

pub fn set_canonical(&mut self, on: bool)

Set or clear canonical mode on an existing writer (C ABI / FFI).

pub fn is_canonical(&self) -> bool

Whether canonical serialization is enabled.

pub fn write_frame(&mut self, frame: &ConFrame) -> Result<()>

Writes a single ConFrame to the output stream.

pub fn extend<'a>( &mut self, frames: impl Iterator<Item = &'a ConFrame>, ) -> Result<()>

Writes all frames from an iterator to the output stream.

This is the most convenient way to write a multi-frame file.

impl ConFrameWriter<File>

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>

Creates a new ConFrameWriter that writes to a file at the given path.

This is a convenience function that creates the file and wraps it.

pub fn from_path_with_precision<P: AsRef<Path>>( path: P, precision: usize, ) -> Result<Self>

Creates a new ConFrameWriter that writes to a file with a custom precision.

impl ConFrameWriter<GzEncoder<File>>

pub fn from_path_gzip<P: AsRef<Path>>(path: P) -> Result<Self>

Creates a gzip-compressed writer for the given path.

pub fn from_path_gzip_with_precision<P: AsRef<Path>>( path: P, precision: usize, ) -> Result<Self>

Creates a gzip-compressed writer with custom precision.