Struct rfd::FileDialog
source · [−]pub struct FileDialog { /* private fields */ }
Expand description
Synchronous File Dialog. Supported platforms:
- Linux
- Windows
- Mac
Implementations
sourceimpl FileDialog
impl FileDialog
sourcepub fn add_filter(self, name: &str, extensions: &[&str]) -> Self
pub fn add_filter(self, name: &str, extensions: &[&str]) -> 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: &str) -> Self
pub fn set_file_name(self, file_name: &str) -> Self
Set starting file name of the dialog. Supported platforms:
- Windows
- Linux
- Mac
sourcepub fn set_title(self, title: &str) -> Self
pub fn set_title(self, title: &str) -> Self
Set the title of the dialog. Supported platforms:
- Windows
- Linux
- Mac (Only below version 10.11)
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
sourceimpl FileDialog
impl FileDialog
sourcepub fn pick_files(self) -> Option<Vec<PathBuf>>
pub fn pick_files(self) -> Option<Vec<PathBuf>>
Pick multiple files
sourcepub fn pick_folder(self) -> Option<PathBuf>
pub fn pick_folder(self) -> Option<PathBuf>
Pick one folder
sourcepub fn save_file(self) -> Option<PathBuf>
pub fn save_file(self) -> Option<PathBuf>
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
Trait Implementations
sourceimpl Clone for FileDialog
impl Clone for FileDialog
sourcefn clone(&self) -> FileDialog
fn clone(&self) -> FileDialog
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for FileDialog
impl Debug for FileDialog
sourceimpl Default for FileDialog
impl Default for FileDialog
sourcefn default() -> FileDialog
fn default() -> FileDialog
Returns the “default value” for a type. Read more
impl Send for FileDialog
Auto Trait Implementations
impl RefUnwindSafe for FileDialog
impl !Sync for FileDialog
impl Unpin for FileDialog
impl UnwindSafe for FileDialog
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more