Struct cap_directories::ProjectDirs

pub struct ProjectDirs { /* fields omitted */ }

ProjectDirs computes the cache, config or data directories for a specific application, which are derived from the standard directories and the name of the project/organization.

This corresponds to directories_next::ProjectDirs, except that the functions create the directories if they don’t exist, open them, and return Dirs instead of returning Paths.

Unlike directories_next::ProjectDirs, this API has no ProjectDirs::from_path, ProjectDirs::path or ProjectDirs::project_path, and the *_dir functions return Dirs rather than Paths, because absolute paths don’t interoperate well with the capability model.

Implementations

impl ProjectDirs

pub unsafe fn from(
    qualifier: &str,
    organization: &str,
    application: &str
) -> Option<Self>

Creates a ProjectDirs struct from values describing the project.

This corresponds to directories_next::ProjectDirs::from.

Safety

This function is unsafe because it makes use of ambient authority to access the project directories, which doesn’t uphold the invariant of the rest of the API. It is otherwise safe to use.

pub fn cache_dir(&self) -> Result<Dir>

Returns the project’s cache directory.

This corresponds to directories_next::ProjectDirs::cache_dir.

pub fn config_dir(&self) -> Result<Dir>

Returns the project’s config directory.

This corresponds to directories_next::ProjectDirs::config_dir.

pub fn data_dir(&self) -> Result<Dir>

Returns the project’s data directory.

This corresponds to directories_next::ProjectDirs::data_dir.

pub fn data_local_dir(&self) -> Result<Dir>

Returns the project’s local data directory.

This corresponds to directories_next::ProjectDirs::data_local_dir.

pub fn runtime_dir(&self) -> Result<Dir>

Returns the project’s runtime directory.

This corresponds to directories_next::ProjectDirs::runtime_dir.

Trait Implementations

impl Clone for ProjectDirs

fn clone(&self) -> ProjectDirs

Returns a copy of the value.

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

Performs copy-assignment from source.