Struct termscp::fs::explorer::FileExplorer

pub struct FileExplorer {
    pub wrkdir: PathBuf,
    // some fields omitted
}

FileExplorer

File explorer states

Fields

wrkdir: PathBuf

Implementations

impl FileExplorer

pub fn pushd(&mut self, dir: &Path)

pushd

push directory to stack

pub fn popd(&mut self) -> Option<PathBuf>

popd

Pop directory from the stack and return the directory

pub fn set_files(&mut self, files: Vec<FsEntry>)

set_files

Set Explorer files This method will also sort entries based on current options Once all sorting have been performed, index is moved to first valid entry.

pub fn count(&self) -> usize

count

Return amount of files

pub fn iter_files(&self) -> impl Iterator<Item = &FsEntry> + '_

iter_files

Iterate over files Filters are applied based on current options (e.g. hidden files not returned)

pub fn iter_files_all(&self) -> impl Iterator<Item = &FsEntry> + '_

iter_files_all

Iterate all files; doesn't care about options

pub fn get_current_file(&self) -> Option<&FsEntry>

get_current_file

Get file at index

pub fn sort_by(&mut self, sorting: FileSorting)

sort_by

Choose sorting method; then sort files

pub fn get_file_sorting(&self) -> FileSorting

get_file_sorting

Get current file sorting method

pub fn group_dirs_by(&mut self, group_dirs: Option<GroupDirs>)

group_dirs_by

Choose group dirs method; then sort files

pub fn incr_index(&mut self)

incr_index

Increment index to the first visible FsEntry. If index goes to files.len() - 1, the value will be seto to the minimum acceptable value

pub fn incr_index_by(&mut self, n: usize)

incr_index_by

Increment index by up to n If index goes to files.len() - 1, the value will be seto to the minimum acceptable value

pub fn decr_index(&mut self)

decr_index

Decrement index to the first visible FsEntry. If index is 0, its value will be set to the maximum acceptable value

pub fn decr_index_by(&mut self, n: usize)

decr_index_by

Decrement index by up to n

pub fn index_at_first(&mut self)

index_at_first

Move index to first "visible" fs entry

pub fn get_index(&self) -> usize

get_index

Return index

pub fn get_relative_index(&self) -> usize

get_relative_index

Get relative index based on current options

pub fn set_index(&mut self, idx: usize)

set_index

Set index to idx. If index exceeds size, is set to count() - 1; or 0

pub fn set_abs_index(&mut self, idx: usize)

set_abs_index

Set absolute index

pub fn toggle_hidden_files(&mut self)

toggle_hidden_files

Enable/disable hidden files

Trait Implementations

impl Default for FileExplorer

pub fn default() -> Self

Returns the "default value" for a type.