Skip to main content

FoamValue

Enum FoamValue 

Source
pub enum FoamValue {
    Scalar(f64),
    Word(String),
    Str(String),
    List(Vec<FoamValue>),
    Dict(FoamDict),
}
Expand description

A leaf value inside a list or a bare token sequence.

Variants§

§

Scalar(f64)

A numeric scalar.

§

Word(String)

A bare identifier / keyword-like word (e.g. ascii, Gauss, PCG, or a function-style grad(U)).

§

Str(String)

A "…" quoted string (stored without the surrounding quotes).

§

List(Vec<FoamValue>)

A parenthesised ( … ) list of values (may nest).

§

Dict(FoamDict)

A { … } sub-dictionary appearing as a list element.

OpenFOAM lists routinely carry dictionaries: constant/polyMesh/boundary and cellZones are N ( name { … } name { … } ), and GeN-Foam’s nuclearData writes its states and zones the same way. Without this variant the braces tokenise into stray Words and the entry silently flattens into nonsense rather than failing.

The name preceding each such dictionary is a separate Word element in the enclosing list — this variant holds only the braced body, exactly as the grammar has it.

Implementations§

Source§

impl FoamValue

Source

pub fn as_vector3(&self) -> Option<Vector3>

Interpret a List of exactly three scalars as a Vector3; returns None for any other shape.

Source

pub fn as_scalar(&self) -> Option<f64>

The scalar value, if this is a FoamValue::Scalar.

Source

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

The word text, if this is a FoamValue::Word.

Trait Implementations§

Source§

impl Clone for FoamValue

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FoamValue

Source§

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

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

impl PartialEq for FoamValue

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FoamValue

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.