#[repr(u16)]
#[non_exhaustive]
pub enum BaseDirectory {
Show 20 variants
Audio,
Cache,
Config,
Data,
LocalData,
Desktop,
Document,
Download,
Executable,
Font,
Home,
Picture,
Public,
Runtime,
Template,
Video,
Resource,
App,
Log,
Temp,
}
Expand description
A base directory to be used in resolve_path
.
The base directory is the optional root of a file system 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 (Non-exhaustive)
This enum is marked as non-exhaustive
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 BaseDirectory::Config
.
Log
The Log directory.
Resolves to BaseDirectory::Home/Library/Logs/{bundle_identifier}
on macOS
and BaseDirectory::Config/{bundle_identifier}/logs
on linux and windows.
Temp
A temporary directory.
Resolves to temp_dir
.
Implementations
sourceimpl BaseDirectory
impl BaseDirectory
sourcepub fn variable(self) -> &'static str
pub fn variable(self) -> &'static str
Gets the variable that represents this BaseDirectory
for string paths.
sourcepub fn from_variable(variable: &str) -> Option<Self>
pub fn from_variable(variable: &str) -> Option<Self>
Gets the BaseDirectory
associated with the given variable, or None
if the variable doesn’t match any.
Trait Implementations
sourceimpl Clone for BaseDirectory
impl Clone for BaseDirectory
sourcefn clone(&self) -> BaseDirectory
fn clone(&self) -> BaseDirectory
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for BaseDirectory
impl Debug for BaseDirectory
sourceimpl<'de> Deserialize<'de> for BaseDirectory
impl<'de> Deserialize<'de> for BaseDirectory
sourcefn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Serialize for BaseDirectory
impl Serialize for BaseDirectory
impl Copy for BaseDirectory
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<'de, D, R> CommandArg<'de, R> for D where
D: Deserialize<'de>,
R: Runtime,
impl<'de, D, R> CommandArg<'de, R> for D where
D: Deserialize<'de>,
R: Runtime,
sourcefn from_command(command: CommandItem<'de, R>) -> Result<D, InvokeError>
fn from_command(command: CommandItem<'de, R>) -> Result<D, InvokeError>
Derives an instance of Self
from the CommandItem
. Read more