Struct Directory 

pub struct Directory {
    pub path: Arc<Path>,
    pub content: Vec<FileInfo>,
    pub index: usize,
    /* 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: Arc<Path>

The current path

content: Vec<FileInfo>

A vector of FileInfo with every file in current path

index: usize

The index of the selected file.

Implementations

impl Directory

pub fn new( path: &Path, users: &Users, filter: &FilterKind, show_hidden: bool, ) -> Result<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, settings: &TabSettings, users: &Users, ) -> Result<()>

pub fn sort(&mut self, sort_kind: &SortKind)

Sort the file with current key.

pub fn owner_column_width(&self) -> usize

Calculates the size of the owner column.

pub fn group_column_width(&self) -> usize

Calculates the size of the group column.

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

Select the file from a given index.

pub fn reset_files( &mut self, settings: &TabSettings, users: &Users, ) -> Result<()>

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

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

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

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) -> Result<String>

A string representation of the git status of the path.

pub fn iter(&self) -> Iter<'_, FileInfo>

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

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

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

pub fn select_file(&mut self, jump_target: &Path) -> usize

Select the file from its path. Returns its index in content.

pub fn paths(&self) -> Vec<&Path>

Returns a vector of paths from content

pub fn is_dotdot_selected(&self) -> bool

True iff the selected path is “..” which is the parent dir.

pub fn videos(&self) -> VecDeque<PathBuf>

Trait Implementations

impl Content<FileInfo> for Directory

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 selected(&self) -> Option<&FileInfo>

Returns a reference to the selected content.

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

A reference to the content.

fn style(&self, index: usize, style: &Style) -> Style

Reverse the received effect if the index match the selected index.

fn push(&mut self, element: FileInfo)

Push a new element at the end of content

impl IndexToIndex<FileInfo> for Directory

fn index_to_index( &self, ) -> Chain<Skip<Iter<'_, FileInfo>>, Take<Iter<'_, FileInfo>>>

Iterate over line from current index to bottom then from top to current index.

Useful when going to next match in search results

impl Selectable for Directory

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 index(&self) -> usize

Returns the index of the selected item.

fn set_index(&mut self, index: usize)

Set the index to a new value if the value is below the length.

fn selected_is_last(&self) -> bool

true if the selected element is the last of content