[−][src]Struct cap_directories::ProjectDirs
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::ProjectDirs
, except that the functions
create the directories if they don't exist, open them, and return Dir
s
instead of returning Path
s.
Unlike directories::ProjectDirs
, this API has no ProjectDirs::from_path
,
ProjectDirs::path
or ProjectDirs::project_path
, and the *_dir
functions return
Dir
s rather than Path
s, because absolute paths don't interoperate well with the
capability model.
Implementations
impl ProjectDirs
[src]
pub unsafe fn from(
qualifier: &str,
organization: &str,
application: &str
) -> Option<Self>
[src]
qualifier: &str,
organization: &str,
application: &str
) -> Option<Self>
Creates a ProjectDirs
struct from values describing the project.
This corresponds to directories::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>
[src]
Returns the project's cache directory.
This corresponds to directories::ProjectDirs::cache_dir
.
pub fn config_dir(&self) -> Result<Dir>
[src]
Returns the project's config directory.
This corresponds to directories::ProjectDirs::config_dir
.
pub fn data_dir(&self) -> Result<Dir>
[src]
Returns the project's data directory.
This corresponds to directories::ProjectDirs::data_dir
.
pub fn data_local_dir(&self) -> Result<Dir>
[src]
Returns the project's local data directory.
This corresponds to directories::ProjectDirs::data_local_dir
.
pub fn preference_dir(&self) -> Result<Dir>
[src]
Returns the project's preference directory.
This corresponds to directories::ProjectDirs::preference_dir
.
pub fn runtime_dir(&self) -> Result<Dir>
[src]
Returns the project's runtime directory.
This corresponds to directories::ProjectDirs::runtime_dir
.
Trait Implementations
impl Clone for ProjectDirs
[src]
fn clone(&self) -> ProjectDirs
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Auto Trait Implementations
impl RefUnwindSafe for ProjectDirs
impl Send for ProjectDirs
impl Sync for ProjectDirs
impl Unpin for ProjectDirs
impl UnwindSafe for ProjectDirs
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,