Struct grafen::database::DataBase

pub struct DataBase {
    pub path: Option<PathBuf>,
    pub residue_defs: Vec<Residue>,
    pub component_defs: Vec<ComponentEntry>,
}

A collection of residues and substrate configurations which can be saved to and read from disk.

Fields

path: Option<PathBuf>

A path to the DataBase location on the hard drive.

residue_defs: Vec<Residue>

Definitions of Residue objects.

component_defs: Vec<ComponentEntry>

New component constructors.

Methods

impl DataBase

fn new() -> DataBase

Construct an empty DataBase.

fn get_path_pretty(&self) -> String

Get the database path enclosed in single quotes if it exists, otherwise the unenclosed string "None".

fn set_path<T: ?Sized>(&mut self, new_path: &T) -> Result<(), DataBaseError> where
    T: AsRef<OsStr>, 

Set a new path for the DataBase. The input path is asserted to be a file and the extension is set to 'json'.

Trait Implementations

impl Clone for DataBase

fn clone(&self) -> DataBase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataBase

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Describe for DataBase

fn describe(&self) -> String

Return a descriptive String of the object.

fn describe_short(&self) -> String

Return a very short descriptive String of the object. Typically just a name or type.