Struct fm::fileinfo::PathContent

pub struct PathContent {
    pub path: PathBuf,
    pub content: Vec<FileInfo>,
    pub index: usize,
    pub show_hidden: bool,
    pub filter: FilterKind,
    /* private fields */
}

Holds the information about file in the current directory. We know about the current path, the files themselves, the selected index, the “display all files including hidden” flag and the key to sort files.

Fields

path: PathBuf

The current path

content: Vec<FileInfo>

A vector of FileInfo with every file in current path

index: usize

The index of the selected file.

show_hidden: bool

Do we display the hidden files ?

filter: FilterKind

The filter use before displaying files

Implementations

impl PathContent

pub fn new(
    path: &Path,
    show_hidden: bool,
    users_cache: Rc<UsersCache>
) -> FmResult<Self>

Reads the paths and creates a new PathContent. Files are sorted by filename by default. Selects the first file if any.

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

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

Apply the filter.

pub fn path_to_str(&self) -> FmResult<&str>

Convert a path to a &str. It may fails if the path contains non valid utf-8 chars.

pub fn sort(&mut self)

Sort the file with current key.

pub fn strings(&self, display_full: bool) -> Vec<String>

Returns a vector of displayable strings for every file.

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

Select the file from a given index.

pub fn reset_files(&mut self) -> Result<(), FmError>

Reset the current file content. Reads and sort the content with current key. Select the first file if any.

pub fn selected_path_string(&self) -> Option<String>

Path of the currently selected file.

pub fn contains(&self, path: &Path) -> bool

True if the path starts with a subpath.

pub fn is_selected_dir(&self) -> FmResult<bool>

Is the selected file a directory ? It may fails if the current path is empty, aka if nothing is selected.

pub fn true_len(&self) -> usize

pub fn used_space(&self) -> String

Human readable string representation of the space used by files in current path. No recursive exploration of directory.

pub fn git_string(&self) -> FmResult<String>

A string representation of the git status of the path.

pub fn update_sort_from_char(&mut self, c: char)

Update the kind of sort from a char typed by the user.

pub fn unselect_current(&mut self)

Unselect the current item. Since we use a common trait to navigate the files, this method is required.

pub fn select_current(&mut self)

Select the current item. Since we use a common trait to navigate the files, this method is required.

pub fn enumerate(&mut self) -> Enumerate<Iter<'_, FileInfo>>

Returns an enumeration of the files (FileInfo) in content.

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

Refresh the existing users.

Trait Implementations

impl Clone for PathContent

fn clone(&self) -> PathContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl SelectableContent<FileInfo> for PathContent

Implement a selectable content for this struct. This trait allows to navigate through a vector of element content_type. It implements: is_empty, len, next, prev, selected. selected returns an optional reference to the value.

fn is_empty(&self) -> bool

True if the content is empty.

fn len(&self) -> usize

The size of the content.

fn prev(&mut self)

Select the prev item.

fn next(&mut self)

Select the next item.

fn selected(&self) -> Option<&FileInfo>

Returns a reference to the selected content.

fn index(&self) -> usize

Returns the index of the selected item.

fn content(&self) -> &Vec<FileInfo>

A reference to the content.