Struct Project 

pub struct Project { /* private fields */ }

Definition of the project essentials. Allows to retrive project directories

Implementations

impl Project

pub fn new(qualifier: &str, organization: &str, application: &str) -> Self

pub fn application_name_unix(&self) -> String

Get application name for UNIX-like systems (excluding mac)

pub fn application_name_windows(&self) -> String

Get application name for Windows systems

pub fn application_name_macos(&self) -> String

Get application name for macOS

pub fn organization_name_windows(&self) -> String

Get organization name for Windows

pub fn organization_name(&self) -> &str

Get organization_name calculated for the current system

pub fn application_name(&self) -> &str

Get application_name calculated for the current system

pub fn qualifier(&self) -> &str

Get qualifier calculated for the current system

pub fn project_dirs(&self) -> Scoped

Trait Implementations

impl Fhs for Project

fn fhs(&self) -> FullProjectDirs

Get standard project directories. Assumes that files can be shared across the system (ex. using nfs)

fn fhs_local(&self) -> FullProjectDirs

Get local project directories. Assumes that files are not shared across the system

impl Unix for Project

fn unix_prefixed(&self, parent_path: &Path, prefix: &str) -> FullProjectDirs

Use custom prefix and parent path for the unix-style directories

fn unix_pwd(&self) -> Result<FullProjectDirs, Error>

Get path to the unix-style directories for the current working directory (PWD). Assumes prefix is “.”.

fn unix_home(&self) -> Option<FullProjectDirs>

Get path to the unix-style directories for the current user. Assumes prefix is “.”.

fn unix_binary(&self) -> Result<FullProjectDirs, Error>

Get path to the unix-style directories for the current binary. Assumes prefix is “.”.

fn unix(&self, parent_path: &Path) -> FullProjectDirs

Same as unix_prefixed, but assumes prefix is “.”

impl Windows for Project

fn windows_system_with_env(&self, env: WindowsEnv) -> ProjectDirs

Returns the project directories for the given environment (using %ProgramFiles%, and %ProgramData%) variables.

fn windows_user_with_env(&self, env: WindowsEnv) -> ProjectDirs

Returns the project directories for the given environment (using %RoamingAppData%, and %LocalAppData%) variables.

fn windows_user_local_with_env(&self, env: WindowsEnv) -> ProjectDirs

Returns the project directories for the given environment (using %LocalAppData%) variables.

fn windows_user_shared_with_env(&self, env: WindowsEnv) -> ProjectDirs

Returns the project directories for the given environment (using %RoamingAppData%) variables.

impl Xdg for Project

fn xdg_with_env_exclude_missing(&self, env: XdgEnv) -> ProjectDirs

Retrive ProjectDirs from XDG variables for the custom env. Do not use fallback to stanard directories.

fn xdg_with_env(&self, env: XdgEnv) -> Result<FullProjectDirs, XdgError>

Tries to retrive FullProjectDirs from XDG variables. May return error in case of missing home fallback

fn xdg(&self) -> Result<FullProjectDirs, XdgError>

Retrive FullProjectDirs from XDG variables. Variables are resolved from the system.