Struct rfd::AsyncFileDialog
source · pub struct AsyncFileDialog { /* private fields */ }
Expand description
Asynchronous File Dialog. Supported platforms:
- Linux
- Windows
- Mac
- WASM32
Implementations§
source§impl AsyncFileDialog
impl AsyncFileDialog
sourcepub fn add_filter(
self,
name: impl Into<String>,
extensions: &[impl ToString]
) -> Self
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
sourcepub fn set_directory<P: AsRef<Path>>(self, path: P) -> Self
pub fn set_directory<P: AsRef<Path>>(self, path: P) -> Self
Set starting directory of the dialog. Supported platforms:
- Linux (GTK only)
- Windows
- Mac
sourcepub fn set_file_name(self, file_name: impl Into<String>) -> Self
pub fn set_file_name(self, file_name: impl Into<String>) -> Self
Set starting file name of the dialog. Supported platforms:
- Windows
- Linux
- Mac
sourcepub fn set_title(self, title: impl Into<String>) -> Self
pub fn set_title(self, title: impl Into<String>) -> Self
Set the title of the dialog. Supported platforms:
- Windows
- Linux
- Mac (Only below version 10.11)
- WASM32
sourcepub fn set_parent<W: HasRawWindowHandle>(self, parent: &W) -> Self
pub fn set_parent<W: HasRawWindowHandle>(self, parent: &W) -> Self
Set parent windows explicitly (optional)
Suported in: macos
and windows
source§impl AsyncFileDialog
impl AsyncFileDialog
sourcepub fn pick_file(self) -> impl Future<Output = Option<FileHandle>>
pub fn pick_file(self) -> impl Future<Output = Option<FileHandle>>
Pick one file
sourcepub fn pick_files(self) -> impl Future<Output = Option<Vec<FileHandle>>>
pub fn pick_files(self) -> impl Future<Output = Option<Vec<FileHandle>>>
Pick multiple files
sourcepub fn pick_folder(self) -> impl Future<Output = Option<FileHandle>>
pub fn pick_folder(self) -> impl Future<Output = Option<FileHandle>>
Pick one folder
Does not exist in WASM32
sourcepub fn pick_folders(self) -> impl Future<Output = Option<Vec<FileHandle>>>
pub fn pick_folders(self) -> impl Future<Output = Option<Vec<FileHandle>>>
Pick multiple folders
Does not exist in WASM32
sourcepub fn save_file(self) -> impl Future<Output = Option<FileHandle>>
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 whenFileHandle::write
is used.
Trait Implementations§
source§impl Clone for AsyncFileDialog
impl Clone for AsyncFileDialog
source§fn clone(&self) -> AsyncFileDialog
fn clone(&self) -> AsyncFileDialog
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for AsyncFileDialog
impl Debug for AsyncFileDialog
source§impl Default for AsyncFileDialog
impl Default for AsyncFileDialog
source§fn default() -> AsyncFileDialog
fn default() -> AsyncFileDialog
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl RefUnwindSafe for AsyncFileDialog
impl Send for AsyncFileDialog
impl !Sync for AsyncFileDialog
impl Unpin for AsyncFileDialog
impl UnwindSafe for AsyncFileDialog
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more