Struct Flagged 

pub struct Flagged {
    pub content: Vec<PathBuf>,
    pub index: usize,
}

The flagged files and an index, allowing navigation when the flagged files are displayed. We record here every flagged file by its path, allowing deletion, renaming, copying, moving and other actions.

Fields

content: Vec<PathBuf>

Contains the different flagged files. It’s basically a Set (of whatever kind) and insertion would be faster using a set. Iteration is faster with a vector and we need a vector to use the common trait SelectableContent which can be implemented with a macro. We use binary search in every non standard method (insertion, removal, search).

index: usize

The index of the selected file. Used to jump.

Implementations

impl Flagged

pub fn update(&mut self, content: Vec<PathBuf>)

pub fn extend(&mut self, content: Vec<PathBuf>)

pub fn clear(&mut self)

pub fn remove_selected(&mut self)

pub fn push(&mut self, path: PathBuf)

Push a new path into the content. We maintain the content sorted and it’s used to make contains faster.

pub fn toggle(&mut self, path: &Path)

Toggle the flagged status of a path. Remove the path from the content if it’s flagged, flag it if it’s not. The implantation assumes the content to be sorted.

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

True if the path is flagged. Since we maintain the content sorted, we can use a binary search and compensate a little bit with using a vector instead of a set.

pub fn in_dir(&self, dir: &Path) -> Vec<PathBuf>

Returns a vector of path which are present in the current directory but ARE NOT the current dir. This prevents the current directory (or root path in tree display mode) to be altered by bulk.

pub fn content_to_string(&self) -> String

Returns a string with every path in content on a separate line.

pub fn replace_by_string(&mut self, files: String)

pub fn as_strings(&self) -> Vec<String>

Returns the flagged files as a vector of strings

pub fn should_all_be_opened_in_neovim(&self) -> bool

pub fn remove_non_existant(&mut self)

Remove all files from flagged which doesn’t exists.

Trait Implementations

impl Content<PathBuf> for Flagged

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

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

Returns a reference to the selected content.

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

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: PathBuf)

Push a new element at the end of content

impl Default for Flagged

fn default() -> Flagged

Returns the “default value” for a type.

impl DrawMenu<PathBuf> for Flagged

fn draw_menu(&self, f: &mut Frame<'_>, rect: &Rect, window: &ContentWindow)

where Self: Content<T>,

impl Selectable for Flagged

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, set_index and selected_is_last.

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