Struct fm::tab::Tab

pub struct Tab {

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

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

window: ContentWindow

The indexes of displayed file

input: Input

Files marked as flagged

path_content: PathContent

Files in current path

height: usize

Height of the terminal window

show_hidden: bool

read from command line

nvim_server: String

NVIM RPC server address

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

Implementations

impl Tab

pub fn new(
    args: Args,
    height: usize,
    users_cache: Rc<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_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 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)

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

Refresh the existing users.

Trait Implementations

impl Clone for Tab

fn clone(&self) -> Tab

Returns a copy of the value.

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

Performs copy-assignment from source.