Struct FullProjectDirs 

pub struct FullProjectDirs {
    pub bin: PathBuf,
    pub cache: PathBuf,
    pub config: PathBuf,
    pub data: PathBuf,
    pub include: PathBuf,
    pub lib: PathBuf,
    pub log: PathBuf,
    pub project_root: Option<PathBuf>,
    pub runtime: Option<PathBuf>,
    pub state: PathBuf,
}

Fully defined project directories by directory type (Directory to PathBuf mapping)

Fields

bin: PathBuf

Binaries directory. This is where the project executable(s) is/are located

cache: PathBuf

Non-essential data, usually used to speed up the application

config: PathBuf

General config store. E.g. conf.d dir and other config files

data: PathBuf

Essential files for application like db files, cross-session data etc.

include: PathBuf

Include dir for C/C++ headers.

lib: PathBuf

Shared library dir for the app

log: PathBuf

Directory handling application logs

project_root: Option<PathBuf>

Project root dir. Not meaningful for strategies like FHS or XDG

runtime: Option<PathBuf>

Runtime files are similar to the cache, but don’t persist between session/reboot NOTE: May be missing in some strategies

state: PathBuf

Non-essential data files that should persist between sessions. E.g. logs, history

Trait Implementations

impl Clone for FullProjectDirs

fn clone(&self) -> FullProjectDirs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FullProjectDirs

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

Formats the value using the given formatter.

impl From<FullProjectDirs> for ProjectDirs

fn from(value: FullProjectDirs) -> Self

Converts to this type from the input type.

impl Mounted for FullProjectDirs

fn mounted(self, mountpoint: &Path) -> Self

impl PartialEq for FullProjectDirs

fn eq(&self, other: &FullProjectDirs) -> 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 TryFrom<ProjectDirs> for FullProjectDirs

type Error = Vec<Directory>

The type returned in the event of a conversion error.

fn try_from(value: ProjectDirs) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for FullProjectDirs

impl StructuralPartialEq for FullProjectDirs