Struct FileDialogCore 

pub struct FileDialogCore {

    pub mode: DialogMode,
    pub cwd: PathBuf,
    pub save_name: String,
    pub click_action: ClickAction,
    pub search: String,
    pub sort_by: SortBy,
    pub sort_ascending: bool,
    pub sort_mode: SortMode,
    pub dirs_first: bool,
    pub allow_multi: bool,
    pub max_selection: Option<usize>,
    pub show_hidden: bool,
    pub double_click: bool,
    pub places: Places,
    pub save_policy: SavePolicy,
    /* private fields */
}

Core state machine for the ImGui-embedded file dialog.

This type contains only domain state and logic (selection, navigation, filtering, sorting). It does not depend on Dear ImGui types and can be unit tested by driving its methods.

Fields

mode: DialogMode

Mode.

cwd: PathBuf

Current working directory.

save_name: String

Optional filename input for SaveFile.

click_action: ClickAction

Click behavior for directories: select or navigate.

search: String

Search query to filter entries by substring (case-insensitive).

sort_by: SortBy

Current sort column.

sort_ascending: bool

Sort order flag (true = ascending).

sort_mode: SortMode

String comparison mode used for sorting.

dirs_first: bool

Put directories before files when sorting.

allow_multi: bool

Allow selecting multiple files.

max_selection: Option<usize>

Optional cap for maximum number of selected files (OpenFiles mode).

• None => no limit
• Some(1) => single selection

show_hidden: bool

Show dotfiles (simple heuristic).

double_click: bool

Double-click navigates/confirm (directories/files).

places: Places

Places shown in the left pane (System + Bookmarks + custom groups).

save_policy: SavePolicy

Save behavior knobs (SaveFile mode only).

Implementations

impl FileDialogCore

pub fn new(mode: DialogMode) -> Self

Creates a new dialog core for a mode.

pub fn can_navigate_back(&self) -> bool

Returns whether a “back” navigation is currently possible.

pub fn can_navigate_forward(&self) -> bool

Returns whether a “forward” navigation is currently possible.

pub fn recent_paths(&self) -> impl Iterator<Item = &PathBuf>

Returns recently visited directories (most recent first).

pub fn filters(&self) -> &[FileFilter]

Returns all configured filters.

pub fn set_filters(&mut self, filters: Vec<FileFilter>)

Replaces the current filter list and resets selection to “auto first filter”.

Use Self::set_active_filter_all to explicitly select “All files” afterwards.

pub fn add_filter(&mut self, filter: impl Into<FileFilter>)

Adds a filter to the end of the filter list.

pub fn extend_filters<I, F>(&mut self, filters: I)

where I: IntoIterator<Item = F>, F: Into<FileFilter>,

Adds multiple filters to the end of the filter list.

pub fn clear_filters(&mut self)

Clears all filters and selects “All files”.

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

Returns the active filter index (into Self::filters) if any.

pub fn active_filter(&self) -> Option<&FileFilter>

Returns the active filter (if any).

pub fn set_active_filter_all(&mut self)

Explicitly select “All files” as the active filter.

pub fn set_active_filter_index(&mut self, index: usize) -> bool

Explicitly select a filter by index.

Returns false if the index is out of bounds.

pub fn handle_event(&mut self, event: CoreEvent) -> CoreEventOutcome

Apply one core event and return host-facing outcome.

pub fn invalidate_dir_cache(&mut self)

Mark the current directory snapshot as dirty so it will be refreshed on next draw.

pub fn scan_policy(&self) -> ScanPolicy

Returns the currently configured scan policy.

pub fn set_scan_policy(&mut self, policy: ScanPolicy)

Sets scan policy for future directory refreshes.

Values are normalized to avoid invalid batch sizes. Calling this invalidates the directory cache when policy changes.

pub fn scan_generation(&self) -> u64

Returns the latest issued scan generation.

pub fn scan_status(&self) -> &ScanStatus

Returns the current scan status.

pub fn request_rescan(&mut self)

Requests a rescan on the next refresh tick.

pub fn set_scan_hook<F>(&mut self, hook: F)

where F: FnMut(&mut FsEntry) -> ScanHookAction + 'static,

Installs a scan hook that can mutate or drop filesystem entries.

The hook runs before filtering/sorting and before snapshot ids are built. Calling this invalidates the directory cache.

pub fn clear_scan_hook(&mut self)

Clears the scan hook and reverts to raw filesystem entries.

Calling this invalidates the directory cache.

pub fn set_cwd(&mut self, cwd: PathBuf)

Sets the current directory and clears selection/focus.

pub fn focus_and_select_by_id(&mut self, id: EntryId)

Selects and focuses a single entry by id.

pub fn replace_selection_by_ids<I>(&mut self, ids: I)

where I: IntoIterator<Item = EntryId>,

Replace selection by entry ids.

pub fn clear_selection(&mut self)

Clear current selection, focus and anchor.

pub fn selected_len(&self) -> usize

Returns the number of currently selected entries.

pub fn has_selection(&self) -> bool

Returns whether there is at least one selected entry.

pub fn selected_entry_ids(&self) -> Vec<EntryId>

Returns selected entry ids in deterministic selection order.

pub fn selected_entry_paths(&self) -> Vec<PathBuf>

Resolves selected entry paths from ids in the current snapshot.

Any ids that are not currently resolvable are skipped.

pub fn selected_entry_counts(&self) -> (usize, usize)

Counts selected files and directories in the current snapshot.

Returns (files, dirs). Any ids that are not currently resolvable are skipped.

pub fn entry_path_by_id(&self, id: EntryId) -> Option<&Path>

Resolves an entry path from an entry id in the current snapshot.

Returns None when the id is not currently resolvable (for example, before the next rescan after create/rename/paste).

pub fn focused_entry_id(&self) -> Option<EntryId>

Returns the currently focused entry id, if any.

Trait Implementations

impl Debug for FileDialogCore

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

Formats the value using the given formatter.