Struct ElectronInput 

pub struct ElectronInput {
    pub electron: ElectronSpec,
    pub materials: BTreeMap<String, MaterialSpec>,
    pub target: TargetSpec,
    pub run: ElectronRunSpec,
}

The whole electron run description.

Fields

electron: ElectronSpec

Everything electron-specific.

materials: BTreeMap<String, MaterialSpec>

Named materials (as in an ion run).

target: TargetSpec

The layered target (as in an ion run).

run: ElectronRunSpec

History count, seed and threads.

Implementations

impl ElectronInput

pub fn is_electron_toml(text: &str) -> bool

Whether a TOML document is an electron input: it has a top-level electron table.

pub fn from_toml_str(text: &str) -> Result<Self, InputError>

Parse a TOML document (schema errors name the key and line).

pub fn to_toml_string(&self) -> Result<String, InputError>

The input as a TOML document in the same schema.

pub fn resolve(&self) -> Result<ResolvedElectron, InputError>

Validate everything with relative data paths taken from the current directory.

pub fn resolve_in( &self, base_dir: &Path, ) -> Result<ResolvedElectron, InputError>

Validate everything, read the data files (paths relative to base_dir, the input file’s directory) and build the engine’s inputs. Errors name the offending key.

Trait Implementations

impl Clone for ElectronInput

fn clone(&self) -> ElectronInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElectronInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElectronInput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ElectronInput

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ElectronInput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ElectronInput