Skip to main content

AppPaths

Struct AppPaths 

pub struct AppPaths { /* private fields */ }
Expand description

Where one app keeps its files, the same API on every target:

LinuxmacOSWeb
data$XDG_DATA_HOME/<id>~/Library/Application Support/<id>opfs://<profile>/<id>/data
config$XDG_CONFIG_HOME/<id>~/Library/Application Support/<id>opfs://<profile>/<id>/config
cache$XDG_CACHE_HOME/<id>~/Library/Caches/<id>opfs://<profile>/<id>/cache
state$XDG_STATE_HOME/<id>~/Library/Application Support/<id>opfs://<profile>/<id>/state
runtime$XDG_RUNTIME_DIR/<id>$TMPDIR/<id>memory, for the page’s lifetime
user_dirxdg-user-dirs~/Documents, …unsupported

On native targets these are exactly data_dir and the other per-user directories with the id joined on. When one does not resolve (no home directory), durable storage falls back to memory rather than to a path relative to wherever the process started.

The id is one path component, typically the app’s reverse-DNS id. Bytes that cannot appear in one (/, \, :, %, control characters) are percent-escaped, as are the ids ., .. and the empty id, so no id can name a location outside its own.

Implementations§

§

impl AppPaths

pub fn for_app(id: &str) -> AppPaths

The app’s locations in this user’s (or on the web, the page’s profile’s) storage.

pub fn under(root: impl Into<PathBuf>, id: &str) -> AppPaths

Everything below root/<id>: data, config, cache, state and runtime subdirectories, and no user folders, workspace or fonts. For tests and for hosts that give each app a sandbox directory.

pub fn memory(id: &str) -> AppPaths

Everything in memory, for tests; nothing outlives the process.

pub fn with_profile(self, profile: &str) -> AppPaths

Keep web storage in profile’s tree. Native per-user directories belong to one profile already, so native targets and scoped paths resolve as before.

pub fn id(&self) -> &str

The id as it appears in locations, escaped where needed.

pub fn data(&self) -> Location

Durable files the app owns: documents, databases, downloads it manages.

pub fn config(&self) -> Location

Settings the user chose.

pub fn cache(&self) -> Location

Files the app can rebuild, which the system may delete.

pub fn state(&self) -> Location

State worth keeping across restarts but not worth backing up: history, window layout, logs.

pub fn runtime(&self) -> Result<Location, Unsupported<Feature>>

Scratch space for this login session (on the web, this page).

§Errors

[Unsupported] when the session has no private runtime directory (Linux without $XDG_RUNTIME_DIR, macOS without $TMPDIR).

pub fn user_dir(&self, dir: UserDir) -> Result<Location, Unsupported<Feature>>

One of the user’s content folders.

§Errors

[Unsupported] on the web, for scoped paths, and when the user has no such folder (disabled in user-dirs.dirs, or no home directory).

pub fn workspace_root(&self) -> Result<Location, Unsupported<Feature>>

The collaborative workspace the host mounted for this app: $TILO_WORKSPACE_ROOT when absolute, else /var/workspace on a Tilo Linux session ($TILO_WORKSPACE_ID set).

§Errors

[Unsupported] on the web, for scoped paths, and when no workspace is mounted.

pub fn font_root(&self) -> Result<Location, Unsupported<Feature>>

The directory holding the Tilo font catalog: where the OS image installs it on Linux, the app bundle’s Contents/Resources/fonts on macOS. Only the location is resolved; readers verify what they use.

§Errors

[Unsupported] on the web (fonts arrive as data), for scoped paths, and on macOS when the app does not run from a bundle.

Trait Implementations§

§

impl Clone for AppPaths

§

fn clone(&self) -> AppPaths

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
§

impl Debug for AppPaths

§

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

Formats the value using the given formatter. Read more
§

impl PartialEq for AppPaths

§

fn eq(&self, other: &AppPaths) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl Eq for AppPaths

§

impl StructuralPartialEq for AppPaths

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
§

impl<T> AnyEq for T
where T: Any + PartialEq,

§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

§

fn as_any(&self) -> &(dyn Any + 'static)

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Fruit for T
where T: Send + Downcast,

§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T

§

impl<T> WasmNotSync for T
where T: Sync,