Struct Project

pub struct Project {
    pub root_directory: Option<PathBuf>,
    pub project_id: Option<String>,
    pub config_home: Option<PathBuf>,
    pub cache_home: Option<PathBuf>,
    pub data_home: Option<PathBuf>,
}

Fields

root_directory: Option<PathBuf>

The absolute path to the project root directory. This is the top-level directory of the project.

project_id: Option<String>

A unique identifier for the project.

config_home: Option<PathBuf>

The directory for storing project specific configuration.

cache_home: Option<PathBuf>

The directory for storing project specific cache data.

data_home: Option<PathBuf>

The directory for storing project specific data files.

Implementations

impl Project

pub fn discover() -> Result<Self>

Retrieve the project information detected from current directory.

pub async fn discover_and_assume() -> Result<Self>

Retrieve the project information detected from the given directory. If a property is not set, then an opinionated default is used.

pub fn project_hashmap(&self) -> HashMap<String, Option<String>>

Retrieve the project information as a HashMap composed of the environment variables as keys and their values as values.

Trait Implementations

impl Debug for Project

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

Formats the value using the given formatter.

impl Default for Project

fn default() -> Project

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Project

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Project

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

where __S: Serializer,

Serialize this value into the given Serde serializer.