Skip to main content

MediaDirs

std::fs::dirs

Struct MediaDirs 

Source 
pub struct MediaDirs {
    pub(crate) desktop: Option<PathBuf>,
    pub(crate) documents: Option<PathBuf>,
    pub(crate) downloads: Option<PathBuf>,
    pub(crate) music: Option<PathBuf>,
    pub(crate) pictures: Option<PathBuf>,
    pub(crate) videos: Option<PathBuf>,
    pub(crate) extra: ExtraMediaDirs,
}
🔬This is a nightly-only experimental API. (fs_media_dirs #162083)
Expand description

Common user directory paths used for user-specific media files.

It is not required that the media directories are accessible by the current user, nor that there is a directory at that path. A robust application should handle the case where media directories are incorrectly configured.

Even when configured correctly, multiple paths may point to the same location. You should not assume that a file written relative to one directory will not conflict with the same relative path in a different media directory.

§Platform-specific behavior

As the filesystem conventions for discovering directories varies between operating systems, constructors for MediaDirs that use the host platform’s conventions are provided as extension traits under the std::os module.

Fields§

§desktop: Option<PathBuf>
🔬This is a nightly-only experimental API. (fs_media_dirs #162083)
§documents: Option<PathBuf>
🔬This is a nightly-only experimental API. (fs_media_dirs #162083)
§downloads: Option<PathBuf>
🔬This is a nightly-only experimental API. (fs_media_dirs #162083)
§music: Option<PathBuf>
🔬This is a nightly-only experimental API. (fs_media_dirs #162083)
§pictures: Option<PathBuf>
🔬This is a nightly-only experimental API. (fs_media_dirs #162083)
§videos: Option<PathBuf>
🔬This is a nightly-only experimental API. (fs_media_dirs #162083)
§extra: ExtraMediaDirs
🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

Implementations§

Source§

impl MediaDirs

Source

pub fn empty() -> Self

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

Create a known user directory set with no known directories.

This is useful with the builder set_* methods to create a MediaDirs with exactly the directories you want, without any other defaults.

Source

pub fn desktop(&self) -> Option<&Path>

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

The OS-recognized user “Desktop” directory, often the Desktop folder in the user’s home directory.

As a media directory, this should typically be used as a default path for file selection dialogs, not for automatically accessed file paths.

§Platform-specific behavior

When constructed using platform-specific conventions, the value is:

OSPath
XDG (Linux)xdg-user-dir DESKTOP ($HOME/Desktop)
Darwin (macOS)NSDesktopDirectory ($HOME/Desktop)
Windows{FOLDERID_Desktop} (%USERPROFILE%\Desktop)

Other paths can be configured via set_desktop.

Source

pub fn documents(&self) -> Option<&Path>

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

The OS-recognized user “Documents” directory, often the Documents folder in the user’s home directory.

As a media directory, this should typically be used as a default path for file selection dialogs, not for automatically accessed file paths.

§Platform-specific behavior

When constructed using platform-specific conventions, the value is:

OSPath
XDG (Linux)xdg-user-dir DOCUMENTS ($HOME/Documents)
Darwin (macOS)NSDocumentDirectory ($HOME/Documents)
Windows{FOLDERID_Documents} (%USERPROFILE%\Documents)

Other paths can be configured via set_documents.

Source

pub fn downloads(&self) -> Option<&Path>

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

The OS-recognized user “Downloads” directory, often the Downloads folder in the user’s home directory.

As a media directory, this should typically be used as a default path for file selection dialogs, not for automatically accessed file paths.

§Platform-specific behavior

When constructed using platform-specific conventions, the value is:

OSPath
XDG (Linux)xdg-user-dir DOWNLOAD ($HOME/Downloads)
Darwin (macOS)NSDownloadsDirectory ($HOME/Downloads)
Windows{FOLDERID_Downloads} (%USERPROFILE%\Downloads)

Other paths can be configured via set_downloads.

Source

pub fn music(&self) -> Option<&Path>

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

The OS-recognized user “Music” directory, often the Music folder in the user’s home directory.

As a media directory, this should typically be used as a default path for file selection dialogs, not for automatically accessed file paths.

§Platform-specific behavior

When constructed using platform-specific conventions, the value is:

OSPath
XDG (Linux)xdg-user-dir MUSIC ($HOME/Music)
Darwin (macOS)NSMusicDirectory ($HOME/Music)
Windows{FOLDERID_Music} (%USERPROFILE%\Music)

Other paths can be configured via set_music.

Source

pub fn pictures(&self) -> Option<&Path>

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

The OS-recognized user “Pictures” directory, often the Pictures folder in the user’s home directory.

As a media directory, this should typically be used as a default path for file selection dialogs, not for automatically accessed file paths.

§Platform-specific behavior

When constructed using platform-specific conventions, the value is:

OSPath
XDG (Linux)xdg-user-dir PICTURES ($HOME/Pictures)
Darwin (macOS)NSPicturesDirectory ($HOME/Pictures)
Windows{FOLDERID_Pictures} (%USERPROFILE%\Pictures)

Other paths can be configured via set_pictures.

Source

pub fn videos(&self) -> Option<&Path>

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

The OS-recognized user “Videos” directory, often the Videos folder in the user’s home directory.

As a media directory, this should typically be used as a default path for file selection dialogs, not for automatically accessed file paths.

§Platform-specific behavior

When constructed using platform-specific conventions, the value is:

OSPath
XDG (Linux)xdg-user-dir VIDEOS ($HOME/Videos)
Darwin (macOS)NSMoviesDirectory ($HOME/Movies)
Windows{FOLDERID_Videos} (%USERPROFILE%\Videos)

Other paths can be configured via set_videos.

Source§

impl MediaDirs

Source

pub fn set_desktop(&mut self, path: PathBuf) -> &mut Self

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

Set the path for Self::desktop.

§Panics

Panics if the provided path is not absolute.

Source

pub fn set_documents(&mut self, path: PathBuf) -> &mut Self

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

Set the path for Self::documents.

§Panics

Panics if the provided path is not absolute.

Source

pub fn set_downloads(&mut self, path: PathBuf) -> &mut Self

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

Set the path for Self::downloads.

§Panics

Panics if the provided path is not absolute.

Source

pub fn set_music(&mut self, path: PathBuf) -> &mut Self

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

Set the path for Self::music.

§Panics

Panics if the provided path is not absolute.

Source

pub fn set_pictures(&mut self, path: PathBuf) -> &mut Self

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

Set the path for Self::pictures.

§Panics

Panics if the provided path is not absolute.

Source

pub fn set_videos(&mut self, path: PathBuf) -> &mut Self

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)

Set the path for Self::videos.

§Panics

Panics if the provided path is not absolute.

Trait Implementations§

Source§

impl Clone for MediaDirs

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MediaDirs

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl MediaDirsExt for MediaDirs

Source§

fn xdg() -> Result<Self>

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)
Load the user directory paths according to the xdg-user-dirs tool. Read more
Source§

fn templates(&self) -> Option<&Path>

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)
The OS-privileged user “Templates” directory, often the Templates folder in the user’s home directory. Read more
Source§

fn set_templates(&mut self, path: PathBuf) -> &mut Self

🔬This is a nightly-only experimental API. (fs_media_dirs #162083)
Set the paths for Self::templates. 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 #126799)
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> SizeHint for T
where T: ?Sized,

Source§

default fn lower_bound(&self) -> usize

🔬This is a nightly-only experimental API. (core_io_internals)
Returns a lower bound on the number of elements this container-like item contains. For example, an array [u8; 12] could return any value between 0 and 12 inclusively as a correct implementation. Read more
Source§

default fn upper_bound(&self) -> Option<usize>

🔬This is a nightly-only experimental API. (core_io_internals)
Returns an upper bound on the number of elements this container-like item contains if it can be determined, otherwise None. Read more
Source§

final fn size_hint(&self) -> (usize, Option<usize>)

🔬This is a nightly-only experimental API. (core_io_internals)
Returns an estimate for the number of elements this container like type contains. Read more
Source§

impl<T> SizedTypeProperties for T

Source§

#[doc(hidden)]
const SIZE: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGNMENT: Alignment = _

🔬This is a nightly-only experimental API. (ptr_alignment_type #102070)
Source§

#[doc(hidden)]
const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
Source§

#[doc(hidden)]
const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const MAX_SLICE_LEN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
The largest safe length for a [Self]. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.