Struct FoamHeader 

pub struct FoamHeader { /* private fields */ }

The FoamFile { … } header block — an ordered flat keyword → raw-value map.

Values are stored verbatim (quotes preserved on the values that had them) so that e.g. version 2.0; round-trips as 2.0 rather than being reparsed to 2, and location "constant/polyMesh"; keeps its quotes.

Implementations

impl FoamHeader

pub fn new() -> Self

A new, empty header.

pub fn standard(class: &str, object: &str) -> Self

The standard header for a given class and object, with version 2.0; format ascii;.

pub fn standard_with_location(class: &str, location: &str, object: &str) -> Self

Like Self::standard but also records a location "…".

pub fn set(&mut self, keyword: &str, value: &str) -> &mut Self

Set keyword → value (replacing in place if present, else appending).

pub fn get(&self, keyword: &str) -> Option<&str>

The raw value bound to keyword (quotes still present if it had them).

pub fn class(&self) -> Option<&str>

The class field, if present.

pub fn object(&self) -> Option<&str>

The object field, if present.

Trait Implementations

impl Clone for FoamHeader

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FoamHeader

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

Formats the value using the given formatter.

impl Default for FoamHeader

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for FoamHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FoamHeader