Struct Model

pub struct Model {
    pub current_directory: PathBuf,
    pub keymap: FilepickerKeyMap,
    pub styles: Styles,
    pub path: Option<PathBuf>,
    /* private fields */
}

The main file picker model containing all state and configuration.

This struct represents the complete state of the file picker, including the current directory, file list, selection state, and styling configuration. It implements the BubbleTeaModel trait for integration with bubbletea-rs applications.

Examples

use bubbletea_widgets::filepicker::Model;
use bubbletea_rs::Model as BubbleTeaModel;

// Create a new file picker
let mut picker = Model::new();

// Or use the BubbleTeaModel::init() method
let (picker, cmd) = Model::init();

State Management

The model maintains:

• Current directory being browsed
• List of files and directories in the current location
• Currently selected item index
• Last selected file path (if any)
• Styling and key binding configuration

Fields

current_directory: PathBuf

The directory currently being browsed. This path is updated when navigating into subdirectories or back to parent directories.

keymap: FilepickerKeyMap

Key bindings configuration for navigation and interaction. Can be customized to change keyboard shortcuts.

styles: Styles

Visual styling configuration for different UI elements. Can be customized to change colors and appearance.

path: Option<PathBuf>

The path of the most recently selected file, if any. This is set when a user selects a file (not a directory) and can be checked using the did_select_file() method.

Implementations

impl Model

pub fn new() -> Self

Creates a new file picker model with default settings.

The file picker starts in the current working directory (“.”) and uses default key bindings and styles. The file list is initially empty and will be populated when the model is initialized or when directories are navigated.

Returns

A new Model instance with:

• Current directory set to “.”
• Default key bindings
• Default styling
• Empty file list (call read_dir() or use BubbleTeaModel::init() to populate)
• No file selected

Examples

use bubbletea_widgets::filepicker::Model;

let mut picker = Model::new();
assert_eq!(picker.current_directory.as_os_str(), ".");
assert!(picker.path.is_none());

pub fn did_select_file(&self, msg: &Msg) -> (bool, Option<PathBuf>)

Checks if a file was selected in response to the given message.

This method examines the provided message to determine if it represents a file selection event. It returns both a boolean indicating whether a file was selected and the path of the selected file (if any).

Arguments

• msg - The message to check for file selection events

Returns

A tuple containing:

• bool: true if a file was selected, false otherwise
• Option<PathBuf>: The path of the selected file, or None if no file was selected

Examples

use bubbletea_widgets::filepicker::Model;
use bubbletea_rs::{KeyMsg, Msg};
use crossterm::event::{KeyCode, KeyModifiers};

let mut picker = Model::new();

// Simulate an Enter key press
let key_msg = KeyMsg {
    key: KeyCode::Enter,
    modifiers: KeyModifiers::NONE,
};
let msg: Msg = Box::new(key_msg);

let (selected, path) = picker.did_select_file(&msg);
if selected {
    println!("File selected: {:?}", path);
}

Note

This method only returns true if:

1. The message is a key press of the Enter key
2. A file path is currently stored in self.path (i.e., a file was previously highlighted)

Trait Implementations

impl Clone for Model

fn clone(&self) -> Model

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Model

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

Formats the value using the given formatter.

impl Default for Model

fn default() -> Self

Returns the “default value” for a type.

impl Model for Model

fn init() -> (Self, Option<Cmd>)

Initialize the model with its initial state and optional startup command.

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

Update the model in response to a received message.

fn view(&self) -> String

Render the current model state as a string for terminal display.