Struct bp3d_fs::dirs::App

source · [−]

pub struct App<'a> { /* private fields */ }

Expand description

Represents the application’s directories.

Main entry point to obtain any directory for your application.

These APIs will fail as last resort. If they fail it usually means the system has a problem. The system may also include specific configuration to break applications on purpose, in which case these APIs will also fail.

Implementations

impl<'a> App<'a>

pub fn new(name: &'a str) -> App<'a>

Creates a new application.

Arguments

name: the name of the application.

returns: App

pub fn get_data(&self) -> Result<&Path, Error>

Returns the path to this application’s files.

Use this directory to store any information not intended to be user accessible.

Errors

Returns a MissingDataDir if this system doesn’t have any application writable location; this should never occur on any supported system except if such system is broken.

Returns an Io if some directory couldn’t be created.

pub fn get_cache(&self) -> Result<&Path, Error>

Returns the path to this application’s cache.

Use this directory to store cached files such as downloads, intermediate files, etc.

Errors

Returns an Io if some directory couldn’t be created.

pub fn get_documents(&self) -> Result<&Path, Error>

Returns the path to this application’s public documents.

Use this directory to store any content the user should see and alter.

Errors

Returns an Io if some directory couldn’t be created.

pub fn get_logs(&self) -> Result<&Path, Error>

Returns the path to this application’s logs.

Use this directory to store all logs. The user can view and alter this directory.

Errors

Returns an Io if some directory couldn’t be created.

pub fn get_config(&self) -> Result<&Path, Error>

Returns the path to this application’s config.

Use this directory to store all configs for the current user. This directory is not intended for direct user access.

Errors

Returns an Io if some directory couldn’t be created.

Trait Implementations

impl<'a> Clone for App<'a>

fn clone(&self) -> Self

Returns a copy 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

impl<'a> RefUnwindSafe for App<'a>

impl<'a> Send for App<'a>

impl<'a> Sync for App<'a>

impl<'a> Unpin for App<'a>

impl<'a> UnwindSafe for App<'a>

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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.

const: unstable · source

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.

const: unstable · source

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>,

fn vzip(self) -> V