Struct cap_directories::UserDirs
source · [−]pub struct UserDirs { /* private fields */ }
Expand description
UserDirs
provides paths of user-facing standard directories, following
the conventions of the operating system the library is running on.
This corresponds to directories_next::UserDirs
, except that the
functions open the directories and returns Dir
s instead of returning
Path
s.
Unlike directories_next::UserDirs
, the *_dir
functions return Dir
s
rather than Path
s, because absolute paths don’t interoperate well with
the capability model.
Implementations
sourceimpl UserDirs
impl UserDirs
sourcepub fn new() -> Option<Self>
pub fn new() -> Option<Self>
Creates a UserDirs
struct which holds the paths to user-facing
directories for audio, font, video, etc. data on the system.
This corresponds to directories_next::UserDirs::new
.
sourcepub fn home_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
pub fn home_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
Returns the user’s home directory.
This corresponds to directories_next::UserDirs::home_dir
.
Ambient Authority
This function makes use of ambient authority to access the user directories.
sourcepub fn audio_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
pub fn audio_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
Returns the user’s audio directory.
This corresponds to directories_next::UserDirs::audio_dir
.
Ambient Authority
This function makes use of ambient authority to access the user directories.
sourcepub fn desktop_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
pub fn desktop_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
Returns the user’s desktop directory.
This corresponds to directories_next::UserDirs::desktop_dir
.
Ambient Authority
This function makes use of ambient authority to access the user directories.
sourcepub fn document_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
pub fn document_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
Returns the user’s document directory.
This corresponds to directories_next::UserDirs::document_dir
.
Ambient Authority
This function makes use of ambient authority to access the user directories.
sourcepub fn download_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
pub fn download_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
Returns the user’s download directory.
This corresponds to directories_next::UserDirs::download_dir
.
Ambient Authority
This function makes use of ambient authority to access the user directories.
sourcepub fn font_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
pub fn font_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
Returns the user’s font directory.
This corresponds to directories_next::UserDirs::font_dir
.
Ambient Authority
This function makes use of ambient authority to access the user directories.
sourcepub fn picture_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
pub fn picture_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
Returns the user’s picture directory.
This corresponds to directories_next::UserDirs::picture_dir
.
Ambient Authority
This function makes use of ambient authority to access the user directories.
sourcepub fn public_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
pub fn public_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
Returns the user’s public directory.
This corresponds to directories_next::UserDirs::public_dir
.
Ambient Authority
This function makes use of ambient authority to access the user directories.
sourcepub fn template_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
pub fn template_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
Returns the user’s template directory.
This corresponds to directories_next::UserDirs::template_dir
.
Ambient Authority
This function makes use of ambient authority to access the user directories.
sourcepub fn video_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
pub fn video_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>
Returns the user’s video directory.
This corresponds to directories_next::UserDirs::video_dir
.
Ambient Authority
This function makes use of ambient authority to access the user directories.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for UserDirs
impl Send for UserDirs
impl Sync for UserDirs
impl Unpin for UserDirs
impl UnwindSafe for UserDirs
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more