Struct tauri::PathResolver

source ·
pub struct PathResolver { /* private fields */ }
Expand description

The path resolver is a helper for the application-specific crate::api::path APIs.

Implementations§

source§

impl PathResolver

source

pub fn resource_dir(&self) -> Option<PathBuf>

Returns the path to the resource directory of this app.

Helper function for crate::api::path::resource_dir.

source

pub fn resolve_resource<P: AsRef<Path>>(&self, path: P) -> Option<PathBuf>

Resolves the path of the given resource. Note that the path must be the same as provided in tauri.conf.json.

This function is helpful when your resource path includes a root dir (/) or parent component (..), because Tauri replaces them with a parent folder, so simply using Self::resource_dir and joining the path won’t work.

Examples

tauri.conf.json:

{
  "tauri": {
    "bundle": {
      "resources": ["../assets/*"]
    }
  }
}
tauri::Builder::default()
  .setup(|app| {
    let resource_path = app.path_resolver()
      .resolve_resource("../assets/logo.svg")
      .expect("failed to resolve resource dir");
    Ok(())
  });
source

pub fn app_config_dir(&self) -> Option<PathBuf>

Returns the path to the suggested directory for your app’s config files.

Helper function for crate::api::path::app_config_dir.

source

pub fn app_data_dir(&self) -> Option<PathBuf>

Returns the path to the suggested directory for your app’s data files.

Helper function for crate::api::path::app_data_dir.

source

pub fn app_local_data_dir(&self) -> Option<PathBuf>

Returns the path to the suggested directory for your app’s local data files.

Helper function for crate::api::path::app_local_data_dir.

source

pub fn app_cache_dir(&self) -> Option<PathBuf>

Returns the path to the suggested directory for your app’s cache files.

Helper function for crate::api::path::app_cache_dir.

source

pub fn app_log_dir(&self) -> Option<PathBuf>

Returns the path to the suggested directory for your app’s log files.

Helper function for crate::api::path::app_log_dir.

source

pub fn app_dir(&self) -> Option<PathBuf>

👎Deprecated since 1.2.0: Will be removed in 2.0.0. Use app_config_dir or app_data_dir instead.

Returns the path to the suggested directory for your app’s config files.

source

pub fn log_dir(&self) -> Option<PathBuf>

👎Deprecated since 1.2.0: Will be removed in 2.0.0. Use app_log_dir instead.

Returns the path to the suggested directory for your app’s log files.

Trait Implementations§

source§

impl Clone for PathResolver

source§

fn clone(&self) -> PathResolver

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

impl Debug for PathResolver

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

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 Twhere 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> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> UserEvent for Twhere T: Debug + Clone + Send + 'static,