Struct fm::tab::Tab

pub struct Tab {

    pub mode: Mode,
    pub previous_mode: Mode,
    pub window: ContentWindow,
    pub input: Input,
    pub path_content: PathContent,
    pub height: usize,
    pub show_hidden: bool,
    pub completion: Completion,
    pub must_quit: bool,
    pub preview: Preview,
    pub history: History,
    pub shortcut: Shortcut,
    pub searched: Option<String>,
    pub directory: Directory,
    pub filter: FilterKind,
}

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

Fields

mode: Mode

The mode the application is currenty in

previous_mode: Mode

The mode previously set

window: ContentWindow

The indexes of displayed file

input: Input

The typed input by the user

path_content: PathContent

Files in current path

height: usize

Height of the terminal window

show_hidden: bool

read from command line

completion: Completion

Completion list and index in it.

must_quit: bool

True if the user issued a quit event (Key::Char('q') by default). It’s used to exit the main loop before reseting the cursor.

preview: Preview

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

history: History

Visited directories

shortcut: Shortcut

Predefined shortcuts

searched: Option<String>

Last searched string

directory: Directory

Optional tree view

filter: FilterKind

The filter use before displaying files

Implementations

impl Tab

pub fn new(args: Args, height: usize, users_cache: UsersCache) -> FmResult<Self>

Creates a new tab from args and height.

pub fn fill_completion(&mut self) -> FmResult<()>

Fill the input string with the currently selected completion.

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

Refresh the current view. Input string is emptied, the files are read again, the window of displayed files is reset. The first file is selected.

pub fn go_to_child(&mut self) -> FmResult<()>

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 set_height(&mut self, height: usize)

Set the height of the window and itself.

pub fn must_quit(&self) -> bool

Returns true iff the application has to quit. This methods allows use to reset the cursors and other terminal parameters gracefully.

pub fn path_content_str(&self) -> Option<&str>

Returns a string of the current directory path.

pub fn set_pathcontent(&mut self, path: &Path) -> FmResult<()>

Set the pathcontent to a new path. Reset the window. Add the last path to the history of visited paths.

pub fn set_window(&mut self)

Set the window. Doesn’t require the lenght to be known.

pub fn set_filter(&mut self, filter: FilterKind)

Apply the filter.

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

Set the line index to index and scroll there.

pub fn find_jump_index(&self, jump_target: &Path) -> Option<usize>

Returns the correct index jump target to a flagged files.

pub fn refresh_shortcuts(&mut self, mount_points: &[&Path])

Refresh the shortcuts. It drops non “hardcoded” shortcuts and extend the vector with the mount points.

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

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

pub fn refresh_users(&mut self, users_cache: UsersCache) -> FmResult<()>

Refresh the existing users.

pub fn search_from(&mut self, searched_name: &str, current_index: usize)

Search in current directory for an file whose name contains searched_name, from a starting position next_index. We search forward from that position and start again from top if nothing is found. We move the selection to the first matching file.

pub fn tree_select_root(&mut self, colors: &Colors) -> FmResult<()>

Select the root node of the tree.

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

Move to the parent of current path

pub fn tree_select_parent(&mut self, colors: &Colors) -> FmResult<()>

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, colors: &Colors) -> FmResult<()>

Move down 10 times in the tree

pub fn tree_page_up(&mut self, colors: &Colors) -> FmResult<()>

Move up 10 times in the tree

pub fn tree_select_next(&mut self, colors: &Colors) -> FmResult<()>

Select the next sibling.

pub fn tree_select_prev(&mut self, colors: &Colors) -> FmResult<()>

Select the previous siblging

pub fn tree_select_first_child(&mut self, colors: &Colors) -> FmResult<()>

Select the first child if any.

pub fn tree_go_to_bottom_leaf(&mut self, colors: &Colors) -> FmResult<()>

Go to the last leaf.

pub fn current_path(&mut self) -> &Path

Returns the current path. It Tree mode, it’s the path of the selected node. Else, it’s the current path of pathcontent.

pub fn directory_of_selected(&self) -> FmResult<&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 selected(&self) -> Option<&FileInfo>

Optional Fileinfo of the selected element.

pub fn make_tree(&mut self, colors: &Colors) -> FmResult<()>

Makes a new tree of the current path.

pub fn set_mode(&mut self, new_mode: Mode)

Set a new mode and save the last one

pub fn reset_mode(&mut self)

Reset the last mode. The last mode is set to normal again.

pub fn need_second_window(&self) -> bool

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