Skip to main content

VtkStreamWriter

oxiphysics_io::streaming_io::types

Struct VtkStreamWriter

pub struct VtkStreamWriter {
    pub output: Vec<u8>,
    pub dims: (usize, usize, usize),
    pub spacing: (f64, f64, f64),
    pub origin: (f64, f64, f64),
    pub dataset_name: String,
    pub header_written: bool,
    pub fields_written: usize,
}

Expand description

A streaming writer for VTK legacy format (ASCII structured points).

Builds VTK output incrementally as physics data is produced, without buffering the entire dataset in memory.

Fields§

§output: Vec<u8>

Output buffer (simulates file I/O).

§dims: (usize, usize, usize)

Grid dimensions (nx, ny, nz).

§spacing: (f64, f64, f64)

Grid spacing (dx, dy, dz).

§origin: (f64, f64, f64)

Origin (ox, oy, oz).

§dataset_name: String

Dataset name.

§header_written: bool

Whether the header has been written.

§fields_written: usize

Number of scalar fields written.

Implementations§

impl VtkStreamWriter

pub fn new( dims: (usize, usize, usize), spacing: (f64, f64, f64), origin: (f64, f64, f64), dataset_name: &str, ) -> Self

Create a new VTK stream writer.

pub fn write_header(&mut self)

Write the VTK file header (must be called before any field).

pub fn write_scalar_field(&mut self, field_name: &str, data: &[f64])

Write a scalar field with the given name and data.

Must call write_header first.

pub fn as_str(&self) -> &str

Return a string view of the accumulated output.

pub fn bytes_written(&self) -> usize

Total bytes written.

Trait Implementations§

impl Debug for VtkStreamWriter

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for VtkStreamWriter

impl RefUnwindSafe for VtkStreamWriter

impl Send for VtkStreamWriter

impl Sync for VtkStreamWriter

impl Unpin for VtkStreamWriter

impl UnsafeUnpin for VtkStreamWriter

impl UnwindSafe for VtkStreamWriter

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.