Struct cap_directories::UserDirs

pub struct UserDirs { /* fields omitted */ }

UserDirs provides paths of user-facing standard directories, following the conventions of the operating system the library is running on.

This corresponds to directories::UserDirs, except that the functions open the directories and returns Dirs instead of returning Paths.

Unlike directories::UserDirs, the *_dir functions return Dirs rather than Paths, because absolute paths don't interoperate well with the capability model.

Implementations

impl UserDirs

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::UserDirs::new.

pub unsafe fn home_dir(&self) -> Result<Dir>

Returns the user's home directory.

This corresponds to directories::UserDirs::home_dir.

Safety

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

pub unsafe fn audio_dir(&self) -> Result<Dir>

Returns the user's audio directory.

This corresponds to directories::UserDirs::audio_dir.

Safety

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

pub unsafe fn desktop_dir(&self) -> Result<Dir>

Returns the user's desktop directory.

This corresponds to directories::UserDirs::desktop_dir.

Safety

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

pub unsafe fn document_dir(&self) -> Result<Dir>

Returns the user's document directory.

This corresponds to directories::UserDirs::document_dir.

Safety

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

pub unsafe fn download_dir(&self) -> Result<Dir>

Returns the user's download directory.

This corresponds to directories::UserDirs::download_dir.

Safety

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

pub unsafe fn font_dir(&self) -> Result<Dir>

Returns the user's font directory.

This corresponds to directories::UserDirs::font_dir.

Safety

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

pub unsafe fn picture_dir(&self) -> Result<Dir>

Returns the user's picture directory.

This corresponds to directories::UserDirs::picture_dir.

Safety

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

pub unsafe fn public_dir(&self) -> Result<Dir>

Returns the user's public directory.

This corresponds to directories::UserDirs::public_dir.

Safety

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

pub unsafe fn template_dir(&self) -> Result<Dir>

Returns the user's template directory.

This corresponds to directories::UserDirs::template_dir.

Safety

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

pub unsafe fn video_dir(&self) -> Result<Dir>

Returns the user's video directory.

This corresponds to directories::UserDirs::video_dir.

Safety

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

Trait Implementations

impl Clone for UserDirs

fn clone(&self) -> UserDirs

Returns a copy of the value.

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

Performs copy-assignment from source.