Struct FoamFile 

pub struct FoamFile {
    pub header: Option<FoamHeader>,
    pub dict: FoamDict,
}

A parsed OpenFOAM dictionary file: its FoamFile header (if present) and the body of entries.

Fields

header: Option<FoamHeader>

The FoamFile { … } header, or None if the file had none.

dict: FoamDict

The dictionary body.

Implementations

impl FoamFile

pub fn parse(text: &str) -> Result<Self, IoError>

Parse dictionary text into a header (if any) and body.

pub fn parse_named( text: &str, context: impl Into<String>, ) -> Result<Self, IoError>

Like Self::parse but labels parse errors with context.

pub fn read(path: impl AsRef<Path>) -> Result<Self, IoError>

Read and parse a dictionary file from path.

pub fn to_foam_string(&self) -> String

Serialise to OpenFOAM ASCII text (banner + header + body).

pub fn write(&self, path: impl AsRef<Path>) -> Result<(), IoError>

Write to path as OpenFOAM ASCII text.

Trait Implementations

impl Clone for FoamFile

fn clone(&self) -> FoamFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FoamFile

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

Formats the value using the given formatter.

impl PartialEq for FoamFile

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FoamFile