Struct FilePicker 

pub struct FilePicker { /* private fields */ }

Browse from a root and pick a path. Returns the path, joined to the root as given (a root of . gives paths relative to it).

Implementations

impl FilePicker

pub fn new(prompt: impl Into<String>, root: impl Into<PathBuf>) -> FilePicker

pub fn mode(self, mode: FileMode) -> Self

What may be picked (default: files).

pub fn extensions<I: IntoIterator<Item = S>, S: AsRef<str>>( self, extensions: I, ) -> Self

List only files with one of these extensions (without the dot, any case); directories are still listed, to open.

pub fn show_hidden(self, on: bool) -> Self

Show hidden files (names starting with .) to begin with; Ctrl+T toggles them.

pub fn jail(self, on: bool) -> Self

Keep to the root: nothing outside it is listed, opened or read, and symbolic links out of it are left out. A root that cannot be resolved lists nothing.

pub fn default(self, path: impl Into<PathBuf>) -> Self

The path returned without a terminal when the policy asks for defaults.

pub fn height(self, rows: usize) -> Self

Show at most rows entries at once (default 10).

pub fn preview(self, layout: PreviewLayout) -> Self

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

Start with this filter text.

pub fn rebind(self, action: &str, keys: impl IntoIterator<Item = Key>) -> Self

Make keys do action on this picker only; no keys unbinds it. The actions are the picker’s own (open, up, hidden, in context file) and its list’s (see select_keymap). A name both have means the picker’s: up is going to the parent directory, not the cursor. Write select.up for the list’s (and file.up, if you like, for the picker’s).

pub fn theme(self, theme: Theme) -> Self

pub fn actions(self, actions: Actions) -> Self

Actions offered on every entry (#491).

pub fn menu_key(self, key: Key) -> Self

The key that opens the action menu (default Ctrl+K).

pub fn with_mouse(self, on: bool) -> Self

Report the mouse: a click focuses, a second click opens or picks, and the border beside the preview drags.

pub fn action(&self) -> Option<&str>

The id of the action that picked the entry, if one did.

pub fn directory(&self) -> PathBuf

The directory shown.

pub fn labels(&self) -> Vec<String>

The labels listed, in order (.. first when it is there).

pub fn reopen(&mut self)

Show the list again after the picker finished or was cancelled, in the directory it was in: for a container that opens one picker more than once (a Form’s file field).

Trait Implementations

impl Component for FilePicker

type Output = PathBuf

fn handle(&mut self, event: &Event, context: &Context<'_>) -> Flow<PathBuf>

Handle one event. Ctrl+C never arrives here: the event loop ends the component with Outcome::Interrupted.

fn keymap(&self) -> Keymap

The bindings this component has right now, for a help overlay, a shortcut list or status-bar hints to read (see keymap). A container’s include its focused child’s, before its own. The default declares none.

fn render(&self, context: &Context<'_>) -> View

Render the current state.

fn mouse(&self) -> bool

Whether the component wants mouse events (#476): clicks, drags and the wheel. Off by default, since reporting the mouse takes text selection away from the terminal; a component turns it on when its caller opts in, and run then enables mouse reporting for the session.

fn tick(&self) -> Option<Duration>

How often the component wants Event::Tick, for a spinner or a countdown. None (the default): never.

fn default_value(&self) -> Option<PathBuf>

The value to return when the terminal is not interactive and the policy asks for defaults. None: there is none.

fn prompt( &mut self, _: &mut dyn LineIo, ) -> Result<Option<PathBuf>, NotInteractive>

Ask for the value line by line, for when the terminal is not interactive and the policy asks for a prompt. The default says the component has no line-based form.

fn start(&mut self, context: &Context<'_>) -> Flow<Self::Output>

Called once, before the component is first painted, with the terminal’s size: for work that needs it, such as rendering content at the width. Returning Done or Cancel finishes the component without waiting for an event. The default does nothing.

fn focusable(&self) -> bool

Whether the component takes focus in a container: Tab stops on it and keys go to it. The default: yes. A label, or a component that has finished, says no.

fn focus_step(&mut self, forward: bool) -> bool

Move focus to the next (forward) or previous focus stop inside this component, for Tab and Shift+Tab. false when there is none after the current one, so the container moves on to its next child. The default, for a component that is one stop: false.

fn focus_enter(&mut self, forward: bool) -> bool

Take focus from outside: at the first stop inside when forward, at the last otherwise. false when nothing in it can take focus. The default: whether the component is focusable.