Struct InternalSettings 

pub struct InternalSettings {
    pub force_clear: bool,
    pub must_quit: bool,
    pub nvim_server: String,
    pub opener: Opener,
    pub width: u16,
    pub height: u16,
    pub disks: Disks,
    pub inside_neovim: bool,
    pub copy_file_queue: Vec<(Vec<PathBuf>, PathBuf)>,
    pub in_mem_progress: Option<InMemoryTerm>,
    pub clear_before_quit: bool,
    /* private fields */
}

Internal settings of the status.

Every setting which couldn’t be attached elsewhere and is needed by the whole application. It knows:

• if the content should be completely refreshed,
• if the application has to quit,
• the address of the nvim_server to send files to and if the application was launched from neovim,
• which opener should be used for kind of files,
• the height & width of the application,
• basic informations about disks being used,
• a copy queue to display informations about files beeing copied.

Fields

force_clear: bool

Do we have to clear the screen ?

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.

nvim_server: String

NVIM RPC server address

opener: Opener

The opener used by the application.

width: u16

terminal width

height: u16

terminal height

disks: Disks

Info about the running machine. Only used to detect disks and their mount points.

inside_neovim: bool

true if the application was launched inside a neovim terminal emulator

copy_file_queue: Vec<(Vec<PathBuf>, PathBuf)>

queue of pairs (sources, dest) to be copied. it shouldn’t be massive under normal usage so we can use a vector instead of an efficient queue data structure.

in_mem_progress: Option<InMemoryTerm>

internal progressbar used to display copy progress

clear_before_quit: bool

true if the terminal should be cleared before exit. It’s set to true when we reuse the window to start a new shell.

Implementations

impl InternalSettings

pub fn new(opener: Opener, size: Size, disks: Disks) -> Self

pub fn term_size(&self) -> (u16, u16)

Returns the size of the terminal (width, height)

pub fn update_size(&mut self, width: u16, height: u16)

pub fn force_clear(&mut self)

Set a “force clear” flag to true, which will reset the display. It’s used when some command or whatever may pollute the terminal. We ensure to clear it before displaying again.

pub fn reset_clear(&mut self)

pub fn should_be_cleared(&self) -> bool

pub fn disks(&mut self) -> &Disks

pub fn mount_points(&mut self) -> Vec<&Path>

pub fn update_nvim_listen_address(&mut self)

pub fn copy_file_remove_head(&mut self) -> Result<()>

Remove the top of the copy queue.

pub fn copy_next_file_in_queue( &mut self, fm_sender: Arc<Sender<FmEvents>>, width: u16, ) -> Result<()>

pub fn store_copy_progress(&mut self, in_mem_progress_bar: InMemoryTerm)

Store copy progress bar. When a copy progress bar is stored, display manager is responsible for its display in the left tab.

pub fn unset_copy_progress(&mut self)

Set copy progress bar to None.

pub fn disable_display(&mut self)

Disable the application display. It’s used to give to allow another program to be executed.

pub fn enable_display(&mut self)

Display the application after it gave its terminal to another program.

Enable the display again, clear the screen, set a flag to clear before quitting application.

pub fn is_disabled(&self) -> bool

pub fn open_in_window(&mut self, args: &[&str]) -> Result<()>

pub fn open_single_file(&mut self, path: &Path) -> Result<()>

pub fn open_flagged_files(&mut self, flagged: &Flagged) -> Result<()>

pub fn quit(&mut self)

Set the must quit flag to true. The next update call will exit the application. It doesn’t exit the application itself.

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