Struct AsyncFileDialog

pub struct AsyncFileDialog { /* private fields */ }

Asynchronous File Dialog. Supported platforms:

• Linux
• Windows
• Mac
• WASM32

Implementations

impl AsyncFileDialog

pub fn new() -> Self

New file dialog builder

pub fn add_filter( self, name: impl Into<String>, extensions: &[impl ToString], ) -> Self

Add file extension filter.

Takes in the name of the filter, and list of extensions

The name of the filter will be displayed on supported platforms:

• Windows
• Linux

On platforms that don’t support filter names, all filters will be merged into one filter

pub fn set_directory<P: AsRef<Path>>(self, path: P) -> Self

Set starting directory of the dialog. Supported platforms:

• Linux (GTK only)
• Windows
• Mac

pub fn set_file_name(self, file_name: impl Into<String>) -> Self

Set starting file name of the dialog. Supported platforms:

• Windows
• Linux
• Mac

pub fn set_title(self, title: impl Into<String>) -> Self

Set the title of the dialog. Supported platforms:

• Windows
• Linux
• Mac
• WASM32

pub fn set_parent<W: HasWindowHandle + HasDisplayHandle>( self, parent: &W, ) -> Self

Set parent windows explicitly (optional). Supported platforms:

• Windows
• Mac
• Linux (XDG only)

pub fn set_can_create_directories(self, can: bool) -> Self

Set can create directories in the dialog. Suported in: macos.

impl AsyncFileDialog

pub fn pick_file(self) -> impl Future<Output = Option<FileHandle>>

Pick one file

pub fn pick_files(self) -> impl Future<Output = Option<Vec<FileHandle>>>

Pick multiple files

pub fn pick_folder(self) -> impl Future<Output = Option<FileHandle>>

Pick one folder

Does not exist in WASM32

pub fn pick_folders(self) -> impl Future<Output = Option<Vec<FileHandle>>>

Pick multiple folders

Does not exist in WASM32

pub fn save_file(self) -> impl Future<Output = Option<FileHandle>>

Opens save file dialog

Platform specific notes regarding save dialog filters:

• On MacOs
  • If filter is set, all files will be grayed out (no matter the extension sadly)
  • If user does not type an extension MacOs will append first available extension from filters list
  • If user types in filename with extension MacOs will check if it exists in filters list, if not it will display appropriate message
• On GTK
  • It only filters which already existing files get shown to the user
  • It does not append extensions automatically
  • It does not prevent users from adding any unsupported extension
• On Win:
  • If no extension was provided it will just add currently selected one
  • If selected extension was typed in by the user it will just return
  • If unselected extension was provided it will append selected one at the end, example: test.png.txt
• On Wasm32:
  • No filtering is applied.
  • save_file returns immediately without a dialog prompt. Instead the user is prompted by their browser on where to save the file when FileHandle::write is used.

Trait Implementations

impl Clone for AsyncFileDialog

fn clone(&self) -> AsyncFileDialog

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AsyncFileDialog

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

Formats the value using the given formatter.

impl Default for AsyncFileDialog

fn default() -> AsyncFileDialog

Returns the “default value” for a type.