Struct Tab 

pub struct Tab {

    pub display_mode: Display,
    pub directory: Directory,
    pub tree: Tree,
    pub preview: Preview,
    pub menu_mode: Menu,
    pub window: ContentWindow,
    pub height: usize,
    pub settings: TabSettings,
    pub search: Search,
    pub history: History,
    pub users: Users,
    pub origin_path: Option<PathBuf>,
    pub visual: bool,
}

Holds every thing about the current tab of the application. Most of the mutation is done externally.

Fields

display_mode: Display

Kind of display: Preview, Normal, Tree

directory: Directory

Files in current path

tree: Tree

Tree representation of the same path

preview: Preview

Lines of the previewed files. Empty if not in preview mode.

menu_mode: Menu

The menu currently opened in this tab. Most of the time is spent in EditMode::Nothing

window: ContentWindow

The indexes of displayed file

height: usize

Height of the terminal window

settings: TabSettings

Internal & display settings: show hidden files ? sort method filter kind

search: Search

Last searched string

history: History

Visited directories

users: Users

Users & groups

origin_path: Option<PathBuf>

Saved path before entering “CD” mode. Used if the cd is canceled

visual: bool

Implementations

impl Tab

pub fn new(args: &Args, height: usize, users: Users) -> Result<Self>

Creates a new tab from args and height.

Description

It reads a path from args, which is defaulted to the starting path. It explores the path and creates a content. The path is then selected. If no path was provide from args, the current folder . is selected. Every other attribute has its default value.

Errors

it may fail if the path:

• doesn’t exist
• can’t be explored
• has no parent and isn’t a directory (which can’t happen)

pub fn directory_of_selected(&self) -> Result<&Path>

Returns the directory owning the selected file. In Tree mode, it’s the current directory if the selected node is a directory, its parent otherwise. In normal mode it’s the current working directory.

pub fn current_path(&self) -> &Path

Current path of this tab in directory display mode.

pub fn current_file(&self) -> Result<FileInfo>

Fileinfo of the selected element.

pub fn current_file_string(&self) -> Result<String>

Path of the currently selected file.

pub fn need_menu_window(&self) -> bool

Returns true if the current mode requires 2 windows. Only Tree, Normal & Preview doesn’t require 2 windows.

pub fn directory_str(&self) -> String

Returns a string of the current directory path.

pub fn refresh_params(&mut self)

Refresh everything but the view

pub fn refresh_view(&mut self) -> Result<()>

Refresh the current view. displayed files is reset. The first file is selected.

pub fn refresh_if_needed(&mut self) -> Result<()>

Refresh the view if files were modified in current directory. If a refresh occurs, tries to select the same file as before. If it can’t, the first file (.) is selected. Does nothing in DisplayMode::Preview.

pub fn set_display_mode(&mut self, new_display_mode: Display)

Change the display mode.

pub fn make_tree(&mut self, sort_kind: Option<SortKind>)

Makes a new tree of the current path.

pub fn toggle_tree_mode(&mut self) -> Result<()>

Enter or leave display tree mode.

pub fn make_preview(&mut self) -> Result<()>

Creates a new preview for the selected file. If the selected file is a directory, it will create a tree. Does nothing if directory is empty or in flagged or preview display mode.

pub fn refresh_and_reselect_file(&mut self) -> Result<()>

Refresh the folder, reselect the last selected file, move the window to it.

pub fn select_by_path(&mut self, selected_path: Arc<Path>)

Select the given file from its path. Action depends of the display mode. For directory or tree, it selects the file and scroll to it. when the file doesn’t exists,

• in directory mode, the first file is selected;
• in tree mode, the root is selected.

For preview or fuzzy, it does nothing

pub fn reset_display_mode_and_view(&mut self) -> Result<()>

Reset the display mode and its view.

pub fn set_filter(&mut self, filter: FilterKind) -> Result<()>

pub fn set_height(&mut self, height: usize)

Set the height of the window and itself.

pub fn toggle_hidden(&mut self) -> Result<()>

Display or hide hidden files (filename starting with .).

pub fn scroll_to(&mut self, index: usize)

Set the line index to index and scroll there.

pub fn sort(&mut self, c: char) -> Result<()>

Sort the file with given criteria Valid kind of sorts are : by kind : directory first, files next, in alphanumeric order by filename, by date of modification, by size, by extension. The first letter is used to identify the method. If the user types an uppercase char, the sort is reverse.

pub fn set_sortkind_per_mode(&mut self)

pub fn cd_to_file(&mut self, path: &Path) -> Result<()>

pub fn try_cd_to_file(&mut self, path_str: String) -> Result<bool>

pub fn cd(&mut self, path: &Path) -> Result<()>

Set the pathcontent to a new path. Reset the window. Add the last path to the history of visited paths. Does nothing in preview or flagged display mode.

pub fn back(&mut self) -> Result<()>

pub fn go_to_file<P>(&mut self, file: P)

where P: AsRef<Path>,

Select a file in current view, either directory or tree mode.

pub fn jump(&mut self, jump_target: PathBuf) -> Result<()>

Jump to the jump target. Change the pathcontent and the tree if the jump target isn’t in the currently displayed files.

pub fn history_cd_to_last(&mut self) -> Result<()>

Move back to a previously visited path. It may fail if the user has no permission to visit the path

pub fn move_to_parent(&mut self) -> Result<()>

Move to the parent of current path

pub fn go_to_index(&mut self, index: usize)

Select the file at index and move the window to this file.

pub fn go_to_selected_dir(&mut self) -> Result<()>

Move to the currently selected directory. Fail silently if the current directory is empty or if the selected file isn’t a directory.

pub fn normal_down_one_row(&mut self)

Move down one row if possible.

pub fn normal_up_one_row(&mut self)

Move up one row if possible.

pub fn normal_go_top(&mut self)

Move to the top of the current directory.

pub fn normal_go_bottom(&mut self)

Move to the bottom of current view.

pub fn normal_page_up(&mut self)

Move 10 files up

pub fn normal_page_down(&mut self)

Move down 10 rows

pub fn tree_go_to_root(&mut self) -> Result<()>

Fold every child node in the tree. Recursively explore the tree and fold every node. Reset the display.

pub fn tree_select_parent(&mut self) -> Result<()>

Select the parent of current node. If we were at the root node, move to the parent and make a new tree.

pub fn tree_page_down(&mut self)

Move down 10 times in the tree

pub fn tree_page_up(&mut self)

Move up 10 times in the tree

pub fn tree_select_next(&mut self)

Select the next sibling.

pub fn tree_select_prev(&mut self)

Select the previous siblging

pub fn tree_go_to_bottom_leaf(&mut self)

Go to the last leaf.

pub fn tree_next_sibling(&mut self)

Navigate to the next sibling of current file in tree mode.

pub fn tree_prev_sibling(&mut self)

Navigate to the previous sibling of current file in tree mode.

pub fn tree_enter_dir(&mut self, path: Arc<Path>) -> Result<()>

pub fn preview_go_top(&mut self)

Move the preview to the top

pub fn preview_go_bottom(&mut self)

Move the preview to the bottom

pub fn preview_page_up(&mut self)

Move 30 lines up or an image in Ueberzug.

pub fn preview_page_down(&mut self)

Move down 30 rows except for Ueberzug where it moves 1 image down

pub fn normal_select_row(&mut self, row: u16)

Select a clicked row in display directory

pub fn tree_select_row(&mut self, row: u16) -> Result<()>

Select a clicked row in display tree

pub fn completion_search_files(&mut self) -> Vec<String>

pub fn directory_search_next(&mut self)

pub fn dir_enum_skip_take(&self) -> Take<Skip<Enumerate<Iter<'_, FileInfo>>>>

pub fn cd_origin_path(&mut self) -> Result<()>

pub fn save_origin_path(&mut self)

pub fn toggle_visual(&mut self)

pub fn reset_visual(&mut self)