Struct BaseConfig 

pub struct BaseConfig {
    pub config_path: PathBuf,
    pub database_path: PathBuf,
    pub analysis_options: AnalysisOptions,
    pub m: Array2<f32>,
}

The minimum configuration an application needs to work with a Library.

Fields

config_path: PathBuf

The path to where the configuration file should be stored, e.g. /home/foo/.local/share/bliss-rs/config.json

database_path: PathBuf

The path to where the database file should be stored, e.g. /home/foo/.local/share/bliss-rs/bliss.db

analysis_options: AnalysisOptions

The analysis options set in the database (number of CPU cores for the analysis, desired feature version…)

m: Array2<f32>

The mahalanobis matrix used for mahalanobis distance. Used to customize the distance metric beyond simple euclidean distance. Uses ndarray’s serde feature for serialization / deserialization. Field would look like this: “m”: {“v”: 1, “dim”: [20, 20], “data”: [1.0, 0.0, …, 1.0]}

Implementations

impl BaseConfig

pub fn new( config_path: Option<PathBuf>, database_path: Option<PathBuf>, analysis_options: Option<AnalysisOptions>, ) -> Result<Self>

Create a new, basic config. Upon calls of Config.write(), it will be written to config_path. Any path omitted will instead default to a “clever” path using data directory inference. The “clever” thinking is as follows:

• If the user specified only one of the paths, it will put the other file in the same folder as the given path.
• If the user specified both paths, it will go with what the user chose.
• If the user didn’t select any path, it will try to put everything in the user’s configuration directory, i.e. XDG_CONFIG_HOME.

The number of cores is the number of cores that should be used for any analysis. If not provided, it will default to the computer’s number of cores.

Trait Implementations

impl AppConfigTrait for BaseConfig

fn base_config(&self) -> &BaseConfig

This trait should return the BaseConfig from the parent, user-created Config.

fn base_config_mut(&mut self) -> &mut BaseConfig

This trait should return the BaseConfig from the parent, user-created Config.

fn serialize_config(&self) -> Result<String>

Convert the current config to a String, to be written to a file.

fn set_number_cores(&mut self, number_cores: NonZeroUsize) -> Result<()>

Set the number of desired cores for analysis, and write it to the configuration file.

fn set_features_version( &mut self, features_version: FeaturesVersion, ) -> Result<()>

Set the desired version for analysis, and write it to the configuration file.

fn get_features_version(&self) -> FeaturesVersion

Get the number of desired cores for analysis, and write it to the configuration file.

fn get_number_cores(&self) -> NonZeroUsize

Get the number of desired cores for analysis, and write it to the configuration file.

fn deserialize_config(data: &str) -> Result<Self>

Default implementation to load a config from a JSON file. Reads from a string.

fn from_path(path: &str) -> Result<Self>

Load a config from the specified path, using deserialize_config.

fn write(&self) -> Result<()>

Write the configuration to a file using AppConfigTrait::serialize_config.

impl Clone for BaseConfig

fn clone(&self) -> BaseConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BaseConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BaseConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BaseConfig

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

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 BaseConfig