Struct FilePicker 

pub struct FilePicker { /* private fields */ }

A file picker field for selecting files and directories.

The FilePicker field allows users to browse the filesystem and select files or directories. It can be configured to filter by file type, show/hide hidden files, and control whether files and/or directories can be selected.

Example

use huh::FilePicker;

let picker = FilePicker::new()
    .key("config_file")
    .title("Select Configuration File")
    .description("Choose a .toml or .json file")
    .allowed_types(vec![".toml".to_string(), ".json".to_string()])
    .current_directory(".");

Implementations

impl FilePicker

pub fn new() -> Self

Creates a new file picker field.

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

Sets the field key.

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

Sets the title.

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

Sets the description.

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

Sets the starting directory.

pub fn allowed_types(self, types: Vec<String>) -> Self

Sets the allowed file types (extensions).

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

Sets whether to show hidden files.

pub fn show_size(self, show: bool) -> Self

Sets whether to show file sizes.

pub fn show_permissions(self, show: bool) -> Self

Sets whether to show file permissions.

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

Sets whether files can be selected.

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

Sets whether directories can be selected.

pub fn validate(self, validate: fn(&str) -> Option<String>) -> Self

Sets the validation function.

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

Sets the visible height (number of entries shown).

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

Gets the currently selected path.

pub fn id(&self) -> usize

Returns the field ID.

Trait Implementations

impl Default for FilePicker

fn default() -> Self

Returns the “default value” for a type.

impl Field for FilePicker

fn get_key(&self) -> &str

Returns the field’s key.

fn get_value(&self) -> Box<dyn Any>

Returns the field’s value.

fn error(&self) -> Option<&str>

Returns the current validation error, if any.

fn init(&mut self) -> Option<Cmd>

Initializes the field.

fn update(&mut self, msg: &Message) -> Option<Cmd>

Updates the field with a message.

fn view(&self) -> String

Renders the field.

fn focus(&mut self) -> Option<Cmd>

Focuses the field.

fn blur(&mut self) -> Option<Cmd>

Blurs the field.

fn key_binds(&self) -> Vec<Binding>

Returns the help keybindings.

fn with_theme(&mut self, theme: &Theme)

Sets the theme.

fn with_keymap(&mut self, keymap: &KeyMap)

Sets the keymap.

fn with_width(&mut self, width: usize)

Sets the width.

fn with_height(&mut self, height: usize)

Sets the height.

fn with_position(&mut self, position: FieldPosition)

Sets the field position.

fn skip(&self) -> bool

Returns whether this field should be skipped.

fn zoom(&self) -> bool

Returns whether this field should zoom (take full height).