Struct FileBrowser 

pub struct FileBrowser { /* private fields */ }

The application-owned state of a FilePicker.

Create it with a start folder, start reading with FileBrowser::open and pass every FilePickerMsg to FileBrowser::update; both return the command that reads folders on a background thread.

While a folder is being read, everything shown stays as it was: the folder, its entries, the filter and the selection change together only when the answer arrives, so quick reads never flash an empty or loading state. FileBrowser::loading tells which folder is on its way.

Implementations

impl FileBrowser

pub fn new(folder: impl Into<PathBuf>, mode: PickMode) -> Self

A browser at folder choosing in mode. Nothing is read until FileBrowser::open.

pub fn extensions( self, extensions: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Shows only files with these extensions (without the dot, any case); folders always show.

pub fn folder(&self) -> &Path

The folder shown. While another folder is read it stays the one shown until the answer arrives.

pub fn loading(&self) -> Option<&Path>

The folder being read, from FileBrowser::open until its answer arrives.

pub fn shows_hidden(&self) -> bool

Whether hidden entries are shown.

pub fn selected_path(&self) -> Option<PathBuf>

The path of the selected entry, if any.

pub fn open<Msg: Send + 'static>( &mut self, folder: impl Into<PathBuf>, wrap: impl FnOnce(FilePickerMsg) -> Msg + Send + 'static, ) -> Command<Msg>

Reads folder in the background and goes there when it has been read; wrap turns picker messages into yours. The folder shown stays until then, and a later open makes the answer of this one stale.

wrap is a function such as Msg::Picker or a closure that captures what it needs. It runs once, on the background thread that read the folder, so it must be Send; it is never copied, so it need not be Clone.

pub fn update<Msg: Send + 'static>( &mut self, message: FilePickerMsg, wrap: impl FnOnce(FilePickerMsg) -> Msg + Send + 'static, ) -> Command<Msg>

Applies a picker message. FilePickerMsg::Chosen changes nothing; act on it yourself. wrap is used as by open, for the folder a message asks to read.

Trait Implementations

impl Clone for FileBrowser

fn clone(&self) -> FileBrowser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileBrowser

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

Formats the value using the given formatter.