Struct EnvironmentSpec 

pub struct EnvironmentSpec {
    pub spec: PathBuf,
    pub name: String,
    pub path: PathBuf,
    pub description: String,
    pub body_types: Vec<BodySpec>,
    pub settings: Vec<SettingsSpec>,
    pub extra: HashMap<String, Value>,
}

Static description of an environment and its interfaces.
Each environment specification file contains one of these.

Fields

spec: PathBuf

Filesystem path to the environment’s static specification (this file).

name: String

Name of the environment, should be universally unique.

path: PathBuf

Filesystem path of the environment’s executable program, relative to this file.

description: String

User facing documentation message.

body_types: Vec<BodySpec>

Specification for each type of organism.

settings: Vec<SettingsSpec>

Settings menu items for the user to customize the environment.

extra: HashMap<String, Value>

Environments may include extra information.

Implementations

impl EnvironmentSpec

pub fn new(path: impl AsRef<Path>) -> Self

Load an environment specification from a JSON file.

Trait Implementations

impl Clone for EnvironmentSpec

fn clone(&self) -> EnvironmentSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvironmentSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnvironmentSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EnvironmentSpec

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EnvironmentSpec

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 EnvironmentSpec