Skip to main content

enum.BaseDirectory

#[repr(u16)]pub enum BaseDirectory {
    Audio,
    Cache,
    Config,
    Data,
    LocalData,
    Desktop,
    Document,
    Download,
    Executable,
    Font,
    Home,
    Picture,
    Public,
    Runtime,
    Template,
    Video,
    Resource,
    App,
    Current,
}

A Base Directory to use. The base directory is the optional root of a FS operation. If informed by the API call, all paths will be relative to the path of the given directory.

For more information, check the dirs_next documentation.

Variants#

Audio

The Audio directory.

Cache

The Cache directory.

Config

The Config directory.

Data

The Data directory.

LocalData

The LocalData directory.

Desktop

The Desktop directory.

Document

The Document directory.

Download

The Download directory.

Executable

The Executable directory.

Font

The Font directory.

Home

The Home directory.

Picture

The Picture directory.

Public

The Public directory.

Runtime

The Runtime directory.

Template

The Template directory.

Video

The Video directory.

Resource

The Resource directory.

App

The default App config directory. Resolves to ${CONFIG_DIR}/${APP_NAME}

Current

The current working directory.

Trait Implementations#

impl Clone for BaseDirectory#

fn clone(&self) -> BaseDirectory#

Returns a copy of the value. Read more

pub fn clone_from(&mut self, source: &Self)1.0.0#

Performs copy-assignment from source. Read more

impl Debug for BaseDirectory#

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for BaseDirectory#

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>,#

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for BaseDirectory#

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,#

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations#

impl RefUnwindSafe for BaseDirectory#

impl Send for BaseDirectory#

impl Sync for BaseDirectory#

impl Unpin for BaseDirectory#

impl UnwindSafe for BaseDirectory#

Blanket Implementations#

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

pub fn type_id(&self) -> TypeId#

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T#

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mutT#

Mutably borrows from an owned value. Read more

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,#

impl<T> From<T> for T#

pub fn from(t: T) -> T#

Performs the conversion.

impl<T> Instrument for T#

pub fn instrument(self, span: Span) -> Instrumented<Self>#

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

pub fn in_current_span(self) -> Instrumented<Self>#

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

pub fn into(self) -> U#

Performs the conversion.

impl<T> Pointable for T#

pub const ALIGN: usize#

The alignment of pointer.

type Init = T#

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize#

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'aT#

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mutT#

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)#

Drops the object pointed to by the given pointer. Read more

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

type Owned = T#

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T#

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

pub fn clone_into(&self, target: &mutT)#

๐Ÿ”ฌ This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

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

type Error = Infallible#

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T where V: MultiLane<T>,#

pub fn vzip(self) -> V#