Skip to main content

CheckpointWriter

Struct CheckpointWriter 

Source
pub struct CheckpointWriter;
Expand description

Serialises and deserialises simulation checkpoints as byte buffers.

A checkpoint stores positions, velocities, the current step, and the current simulation time. All values are encoded as little-endian bytes.

Implementations§

Source§

impl CheckpointWriter

Source

pub fn new() -> Self

Create a new checkpoint writer/reader.

Source

pub fn save_state( positions: &[[f64; 3]], velocities: &[[f64; 3]], step: u64, time: f64, ) -> Vec<u8>

Serialise a simulation state to a byte buffer.

  • positionsN particle positions \[x, y, z\] (f64 metres)
  • velocitiesN particle velocities \[vx, vy, vz\] (f64 m/s)
  • step – current step index
  • time – current simulation time (seconds)
Source

pub fn load_state(buf: &[u8]) -> (Vec<[f64; 3]>, Vec<[f64; 3]>, u64, f64)

Deserialise a checkpoint from buf.

Returns (positions, velocities, step, time) or panics if the buffer is too short or the magic bytes are wrong.

Trait Implementations§

Source§

impl Debug for CheckpointWriter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CheckpointWriter

Source§

fn default() -> CheckpointWriter

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.