Struct cushy::dialog::FilePicker

pub struct FilePicker { /* private fields */ }

A dialog that can pick one or more files or directories.

Implementations

impl FilePicker

pub const fn new() -> Self

Returns a new file picker dialog.

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

Sets the title of the dialog and returns self.

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

Sets the initial file name for the dialog and returns self.

pub fn allowing_directory_creation(self, allowed: bool) -> Self

Enables directory creation within the dialog and returns self.

pub fn with_types<Type>(self, types: impl IntoIterator<Item = Type>) -> Self

where Type: Into<FileType>,

Adds the list of type filters to the dialog and returns self.

These type filters are used for the dialog to only show related files and restrict what extensions are allowed to be picked.

pub fn with_initial_directory(self, directory: impl AsRef<Path>) -> Self

Sets the initial directory for the dialog and returns self.

pub fn pick_file<Callback>(&self, pick_in: &impl PickFile, on_dismiss: Callback)

where Callback: FnOnce(Option<PathBuf>) + Send + 'static,

Shows a picker that selects a single file and invokes on_dismiss when the dialog is dismissed.

pub fn save_file<Callback>(&self, pick_in: &impl PickFile, on_dismiss: Callback)

where Callback: FnOnce(Option<PathBuf>) + Send + 'static,

Shows a picker that creates a new file and invokes on_dismiss when the dialog is dismissed.

pub fn pick_files<Callback>( &self, pick_in: &impl PickFile, on_dismiss: Callback, )

where Callback: FnOnce(Option<Vec<PathBuf>>) + Send + 'static,

Shows a picker that selects one or more files and invokes on_dismiss when the dialog is dismissed.

pub fn pick_folder<Callback>( &self, pick_in: &impl PickFile, on_dismiss: Callback, )

where Callback: FnOnce(Option<PathBuf>) + Send + 'static,

Shows a picker that selects a single folder/directory and invokes on_dismiss when the dialog is dismissed.

pub fn pick_folders<Callback>( &self, pick_in: &impl PickFile, on_dismiss: Callback, )

where Callback: FnOnce(Option<Vec<PathBuf>>) + Send + 'static,

Shows a picker that selects one or more folders/directorys and invokes on_dismiss when the dialog is dismissed.

Trait Implementations

impl Clone for FilePicker

fn clone(&self) -> FilePicker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilePicker

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

Formats the value using the given formatter.

impl Default for FilePicker

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for FilePicker

fn eq(&self, other: &FilePicker) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FilePicker

impl StructuralPartialEq for FilePicker