Struct FileDialogBuilder

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

The file dialog builder.

Constructs file picker dialogs that can select single/multiple files or directories.

Implementations

impl<'a> FileDialogBuilder<'a>

pub fn new() -> Self

Gets the default file dialog builder.

pub fn set_default_path(&mut self, default_path: &'a Path) -> &mut Self

Set starting file name or directory of the dialog.

pub fn set_recursive(&mut self, recursive: bool) -> &mut Self

If directory is true, indicates that it will be read recursively later. Defines whether subdirectories will be allowed on the scope or not.

Example

use tauri_sys::dialog::FileDialogBuilder;

let _builder = FileDialogBuilder::new().set_recursive(true);

pub fn set_title(&mut self, title: &'a str) -> &mut Self

Set the title of the dialog.

Example

use tauri_sys::dialog::FileDialogBuilder;

let _builder = FileDialogBuilder::new().set_title("Test Title");

pub fn add_filter( &mut self, name: &'a str, extensions: &'a [&'a str], ) -> &mut Self

Add file extension filter. Takes in the name of the filter, and list of extensions

Example

use tauri_sys::dialog::FileDialogBuilder;

let _builder = FileDialogBuilder::new().add_filter("Image", &["png", "jpeg"]);

pub fn add_filters( &mut self, filters: impl IntoIterator<Item = (&'a str, &'a [&'a str])>, ) -> &mut Self

Add many file extension filters.

Example

use tauri_sys::dialog::FileDialogBuilder;

let _builder = FileDialogBuilder::new().add_filters(&[("Image", &["png", "jpeg"]),("Video", &["mp4"])]);

pub async fn pick_file(&self) -> Result<Option<PathBuf>, Error>

Shows the dialog to select a single file.

Example

use tauri_sys::dialog::FileDialogBuilder;

let file = FileDialogBuilder::new().pick_file().await?;

Requires allowlist > dialog > open to be enabled.

pub async fn pick_files( &mut self, ) -> Result<Option<impl Iterator<Item = PathBuf>>, Error>

Shows the dialog to select multiple files.

Example

use tauri_sys::dialog::FileDialogBuilder;

let files = FileDialogBuilder::new().pick_files().await?;

Requires allowlist > dialog > open to be enabled.

pub async fn pick_folder(&mut self) -> Result<Option<PathBuf>, Error>

Shows the dialog to select a single folder.

Example

use tauri_sys::dialog::FileDialogBuilder;

let files = FileDialogBuilder::new().pick_folder().await?;

Requires allowlist > dialog > open to be enabled.

pub async fn pick_folders( &mut self, ) -> Result<Option<impl Iterator<Item = PathBuf>>, Error>

Shows the dialog to select multiple folders.

Example

use tauri_sys::dialog::FileDialogBuilder;

let files = FileDialogBuilder::new().pick_folders().await?;

Requires allowlist > dialog > open to be enabled.

pub async fn save(&self) -> Result<Option<PathBuf>, Error>

Open a file/directory save dialog.

The selected path is added to the filesystem and asset protocol allowlist scopes. When security is more important than the easy of use of this API, prefer writing a dedicated command instead.

Note that the allowlist scope change is not persisted, so the values are cleared when the application is restarted. You can save it to the filesystem using tauri-plugin-persisted-scope.

Example

use tauri_sys::dialog::FileDialogBuilder;

let file = FileDialogBuilder::new().save().await?;

Requires allowlist > dialog > save to be enabled.

Trait Implementations

impl<'a> Clone for FileDialogBuilder<'a>

fn clone(&self) -> FileDialogBuilder<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for FileDialogBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for FileDialogBuilder<'a>

fn default() -> FileDialogBuilder<'a>

Returns the “default value” for a type.

impl<'a> Hash for FileDialogBuilder<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Serialize for FileDialogBuilder<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.