Struct DirectoryNavigationProvider 

pub struct DirectoryNavigationProvider {
    root: PathBuf,
    source_type: SourceType,
}

A navigation provider that traverses directory structures.

This provider can use either plain filesystem operations or library-aware filtering, depending on the use case:

• Filesystem mode: Shows all directories (for FileChooser)
• Library mode: Respects library settings like hidden file filtering (for Home view)

Examples

Create a filesystem provider for browsing all directories:

use std::path::PathBuf;
use cadmus_core::view::navigation::providers::directory::DirectoryNavigationProvider;

let provider = DirectoryNavigationProvider::filesystem(PathBuf::from("/home/user"));

Create a library provider for filtered navigation:

use std::path::PathBuf;
use cadmus_core::view::navigation::providers::directory::DirectoryNavigationProvider;

let provider = DirectoryNavigationProvider::library(PathBuf::from("/home/user/books"));

Fields

root: PathBuf

source_type: SourceType

Implementations

impl DirectoryNavigationProvider

pub fn filesystem(root: PathBuf) -> Self

Creates a provider for plain filesystem navigation.

This shows all directories without any filtering, suitable for file chooser dialogs that need to browse the entire filesystem.

Examples

use std::path::PathBuf;
use cadmus_core::view::navigation::providers::directory::DirectoryNavigationProvider;

let provider = DirectoryNavigationProvider::filesystem(PathBuf::from("/home/user"));

pub fn library(root: PathBuf) -> Self

Creates a provider for library-aware navigation.

This respects library settings like hidden file filtering, suitable for the Home view navigation.

Examples

use std::path::PathBuf;
use cadmus_core::view::navigation::providers::directory::DirectoryNavigationProvider;

let provider = DirectoryNavigationProvider::library(PathBuf::from("/home/user/books"));

pub fn set_root(&mut self, root: PathBuf)

Updates the root directory for this provider.

fn list_directories(&self, path: &Path, context: &Context) -> BTreeSet<PathBuf>

Lists directories using the configured source.

fn list_filesystem_dirs(&self, path: &Path) -> BTreeSet<PathBuf>

Lists directories from the filesystem without filtering.

fn list_library_dirs(&self, path: &Path, context: &Context) -> BTreeSet<PathBuf>

Lists directories using the library’s filtering rules.

fn guess_bar_size(dirs: &BTreeSet<PathBuf>) -> usize

Trait Implementations

impl Clone for DirectoryNavigationProvider

fn clone(&self) -> DirectoryNavigationProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DirectoryNavigationProvider

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

Formats the value using the given formatter.

impl NavigationProvider for DirectoryNavigationProvider

type LevelKey = PathBuf

Key that identifies a level in the stack.

type LevelData = BTreeSet<PathBuf>

Data needed to render a level.

type Bar = DirectoriesBar

Concrete view used to render a level.

fn selected_leaf_key(&self, selected: &Self::LevelKey) -> Self::LevelKey

Returns the key to consider “selected”.

fn leaf_for_bar_traversal( &self, selected: &Self::LevelKey, context: &Context, ) -> Self::LevelKey

Returns the starting key for bar traversal.

fn parent(&self, current: &Self::LevelKey) -> Option<Self::LevelKey>

Returns the parent key, if any.

fn is_ancestor( &self, ancestor: &Self::LevelKey, descendant: &Self::LevelKey, ) -> bool

Returns true if ancestor is an ancestor of descendant.

fn is_root(&self, key: &Self::LevelKey, _context: &Context) -> bool

Returns true if the key is the root of the stack.

fn fetch_level_data( &self, key: &Self::LevelKey, context: &mut Context, ) -> Self::LevelData

Fetch the data for a level.

fn estimate_line_count( &self, _key: &Self::LevelKey, data: &Self::LevelData, ) -> usize

Estimates how many visual lines (rows) the bar will need to display its content.

fn create_bar(&self, rect: Rectangle, key: &Self::LevelKey) -> Self::Bar

Creates a new empty bar for the given level key.

fn bar_key(&self, bar: &Self::Bar) -> Self::LevelKey

Returns the key that is currently displayed by a bar.

fn update_bar( &self, bar: &mut Self::Bar, data: &Self::LevelData, selected: &Self::LevelKey, fonts: &mut Fonts, )

Update bar content using only fonts (no context borrowing).

fn update_bar_selection(&self, bar: &mut Self::Bar, selected: &Self::LevelKey)

Update bar selection when the content is unchanged.

fn resize_bar_by( &self, bar: &mut Self::Bar, delta_y: i32, fonts: &mut Fonts, ) -> i32

Apply a vertical resize delta to a bar.

fn shift_bar(&self, bar: &mut Self::Bar, delta: Point)

Shift a bar by a delta.