Skip to main content

UserDirs

Struct 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::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§

Source§

impl UserDirs

Source

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.

Source

pub fn home_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>

Returns the user’s home directory.

This corresponds to directories::UserDirs::home_dir.

§Ambient Authority

This function makes use of ambient authority to access the user directories.

Source

pub fn audio_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>

Returns the user’s audio directory.

This corresponds to directories::UserDirs::audio_dir.

§Ambient Authority

This function makes use of ambient authority to access the user directories.

Source

pub fn desktop_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>

Returns the user’s desktop directory.

This corresponds to directories::UserDirs::desktop_dir.

§Ambient Authority

This function makes use of ambient authority to access the user directories.

Source

pub fn document_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>

Returns the user’s document directory.

This corresponds to directories::UserDirs::document_dir.

§Ambient Authority

This function makes use of ambient authority to access the user directories.

Source

pub fn download_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>

Returns the user’s download directory.

This corresponds to directories::UserDirs::download_dir.

§Ambient Authority

This function makes use of ambient authority to access the user directories.

Source

pub fn font_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>

Returns the user’s font directory.

This corresponds to directories::UserDirs::font_dir.

§Ambient Authority

This function makes use of ambient authority to access the user directories.

Source

pub fn picture_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>

Returns the user’s picture directory.

This corresponds to directories::UserDirs::picture_dir.

§Ambient Authority

This function makes use of ambient authority to access the user directories.

Source

pub fn public_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>

Returns the user’s public directory.

This corresponds to directories::UserDirs::public_dir.

§Ambient Authority

This function makes use of ambient authority to access the user directories.

Source

pub fn template_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>

Returns the user’s template directory.

This corresponds to directories::UserDirs::template_dir.

§Ambient Authority

This function makes use of ambient authority to access the user directories.

Source

pub fn video_dir(&self, ambient_authority: AmbientAuthority) -> Result<Dir>

Returns the user’s video directory.

This corresponds to directories::UserDirs::video_dir.

§Ambient Authority

This function makes use of ambient authority to access the user directories.

Trait Implementations§

Source§

impl Clone for UserDirs

Source§

fn clone(&self) -> UserDirs

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.