Struct cap_directories::UserDirs

pub struct UserDirs { /* private fields */ }

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 Dirs instead of returning Paths.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.