Struct FileBrowserState 

pub struct FileBrowserState { /* private fields */ }

State for a FileBrowser component.

Manages the current directory, entries, filtering, sorting, and selection.

Implementations

impl FileBrowserState

pub fn new(path: impl Into<String>, entries: Vec<FileEntry>) -> Self

Creates a new file browser with initial path and entries.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};

let entries = vec![
    FileEntry::directory("src", "/src"),
    FileEntry::file("main.rs", "/main.rs"),
];
let state = FileBrowserState::new("/", entries);
assert_eq!(state.current_path(), "/");
assert_eq!(state.entries().len(), 2);

pub fn with_provider( path: impl Into<String>, provider: Arc<dyn DirectoryProvider>, ) -> Self

Creates a new file browser with a directory provider.

pub fn with_selection_mode(self, mode: SelectionMode) -> Self

Sets the selection mode (builder pattern).

Example

use envision::component::file_browser::{FileEntry, FileBrowserState, SelectionMode};

let state = FileBrowserState::new("/", vec![
    FileEntry::file("a.txt", "/a.txt"),
]).with_selection_mode(SelectionMode::Multiple);
assert_eq!(state.selection_mode(), &SelectionMode::Multiple);

pub fn with_sort_field(self, field: FileSortField) -> Self

Sets the sort field (builder pattern).

Example

use envision::component::file_browser::{FileEntry, FileBrowserState, FileSortField};

let state = FileBrowserState::new("/", vec![
    FileEntry::file("a.txt", "/a.txt"),
]).with_sort_field(FileSortField::Size);
assert_eq!(state.sort_field(), &FileSortField::Size);

pub fn with_sort_direction(self, direction: FileSortDirection) -> Self

Sets the sort direction (builder pattern).

Example

use envision::component::file_browser::{FileEntry, FileBrowserState, FileSortDirection};

let state = FileBrowserState::new("/", vec![
    FileEntry::file("a.txt", "/a.txt"),
]).with_sort_direction(FileSortDirection::Descending);
assert_eq!(state.sort_direction(), &FileSortDirection::Descending);

pub fn with_directories_first(self, directories_first: bool) -> Self

Sets whether directories are shown first (builder pattern).

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

Sets whether hidden files are shown (builder pattern).

pub fn current_path(&self) -> &str

Returns the current directory path.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};

let state = FileBrowserState::new("/home/user", vec![]);
assert_eq!(state.current_path(), "/home/user");

pub fn path_segments(&self) -> &[String]

Returns the path segments for breadcrumb display.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};

let state = FileBrowserState::new("/home/user", vec![]);
assert_eq!(state.path_segments(), &["/", "home", "user"]);

pub fn entries(&self) -> &[FileEntry]

Returns all entries (unfiltered).

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};

let state = FileBrowserState::new("/", vec![
    FileEntry::file("a.txt", "/a.txt"),
    FileEntry::directory("src", "/src"),
]);
assert_eq!(state.entries().len(), 2);

pub fn filtered_indices(&self) -> &[usize]

Returns the indices of visible (filtered) entries.

pub fn filtered_entries(&self) -> Vec<&FileEntry>

Returns the filtered entries.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};

let state = FileBrowserState::new("/", vec![
    FileEntry::file("readme.md", "/readme.md"),
    FileEntry::directory("src", "/src"),
]);
assert_eq!(state.filtered_entries().len(), 2);

pub fn selected_entry(&self) -> Option<&FileEntry>

Returns the currently selected entry.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};

let state = FileBrowserState::new("/", vec![
    FileEntry::file("readme.md", "/readme.md"),
]);
let entry = state.selected_entry().unwrap();
assert_eq!(entry.name(), "readme.md");

pub fn selected_index(&self) -> Option<usize>

Returns the selected index within the filtered list.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};

let state = FileBrowserState::new("/", vec![FileEntry::file("a.txt", "/a.txt")]);
assert_eq!(state.selected_index(), Some(0));

let empty = FileBrowserState::new("/", vec![]);
assert_eq!(empty.selected_index(), None);

pub fn selected(&self) -> Option<usize>

Returns the selected index within the filtered list.

This is an alias for selected_index() that provides a consistent accessor name across all selection-based components.

pub fn selected_item(&self) -> Option<&FileEntry>

Returns the currently selected file entry.

This is an alias for selected_entry() that provides a consistent accessor name across all selection-based components.

pub fn selected_paths(&self) -> &[String]

Returns the selected paths (for multi-select mode).

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};

let state = FileBrowserState::new("/", vec![]);
assert!(state.selected_paths().is_empty());

pub fn filter_text(&self) -> &str

Returns the current filter text.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};

let state = FileBrowserState::new("/", vec![]);
assert_eq!(state.filter_text(), "");

pub fn selection_mode(&self) -> &SelectionMode

Returns the selection mode.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState, SelectionMode};

let state = FileBrowserState::new("/", vec![])
    .with_selection_mode(SelectionMode::Multiple);
assert_eq!(state.selection_mode(), &SelectionMode::Multiple);

pub fn sort_field(&self) -> &FileSortField

Returns the sort field.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState, FileSortField};

let state = FileBrowserState::new("/", vec![]);
assert_eq!(state.sort_field(), &FileSortField::Name);

pub fn sort_direction(&self) -> &FileSortDirection

Returns the sort direction.

pub fn show_hidden(&self) -> bool

Returns whether hidden files are shown.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};

let state = FileBrowserState::new("/", vec![]);
assert!(!state.show_hidden());

let state = FileBrowserState::new("/", vec![]).with_show_hidden(true);
assert!(state.show_hidden());

pub fn set_show_hidden(&mut self, show: bool)

Sets whether hidden files are shown.

Example

use envision::component::FileBrowserState;

let mut state = FileBrowserState::new("/", vec![]);
state.set_show_hidden(true);
assert!(state.show_hidden());

pub fn update(&mut self, msg: FileBrowserMessage) -> Option<FileBrowserOutput>

Updates the state with a message, returning any output.

Example

use envision::component::file_browser::{FileEntry, FileBrowserState};
use envision::component::{FileBrowserMessage, FileBrowserOutput};

let mut state = FileBrowserState::new("/", vec![
    FileEntry::file("a.txt", "/a.txt"),
    FileEntry::file("b.txt", "/b.txt"),
]);
let output = state.update(FileBrowserMessage::Down);
assert_eq!(output, Some(FileBrowserOutput::SelectionChanged(1)));

Trait Implementations

impl Clone for FileBrowserState

fn clone(&self) -> FileBrowserState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileBrowserState

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

Formats the value using the given formatter.

impl Default for FileBrowserState

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for FileBrowserState

fn eq(&self, other: &Self) -> 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.