Struct GrowerInputs 

pub struct GrowerInputs { /* private fields */ }

Represents the primary user- or AI-supplied environment description and other essential context. These inputs are typically consumed by later crates to shape tree parameters, regenerate models, etc.

We rely exclusively on derive_builder for constructing instances, rather than providing a separate new method.

Implementations

impl GrowerInputs

pub fn global_environment_descriptor(&self) -> &Option<String>

A textual description of the overall environment.

pub fn target(&self) -> &String

A plain string name for the crate that we will ultimately generate.

pub fn neighbors(&self) -> &Vec<String>

A list of relevant neighbor crate names or contexts.

pub fn sub_environments(&self) -> &Vec<String>

A list of sub-environments relevant to this crate.

impl GrowerInputs

pub fn global_environment_display(&self) -> String

pub fn sub_environment_display(&self) -> String

pub fn neighbor_display(&self) -> String

pub fn output_file_name(&self) -> String

pub fn validate(&self) -> Result<(), GrowerInputError>

Validates essential fields. Returns an Err if any major constraint is violated.

pub fn from_toml_str(toml_str: &str) -> Result<Self, GrowerInputError>

Parses a GrowerInputs from a TOML string.

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

Converts this GrowerInputs into a TOML string.

pub fn from_toml_file<P: Debug + AsRef<Path>>( path: P, ) -> Result<Self, GrowerInputError>

Loads a GrowerInputs from a TOML file on disk.

pub fn to_toml_file<P: Debug + AsRef<Path>>( &self, path: P, ) -> Result<(), GrowerInputError>

Writes this GrowerInputs out to a TOML file on disk.

Trait Implementations

impl Clone for GrowerInputs

fn clone(&self) -> GrowerInputs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GrowerInputs

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

Formats the value using the given formatter.

impl Default for GrowerInputs

fn default() -> GrowerInputs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GrowerInputs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for GrowerInputs

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for GrowerInputs

fn eq(&self, other: &GrowerInputs) -> 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 GrowerInputs

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructOpt for GrowerInputs

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error>

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making.

impl Eq for GrowerInputs

impl StructuralPartialEq for GrowerInputs