Struct broot::browser::BrowserState

pub struct BrowserState {
    pub tree: Tree,
    pub filtered_tree: Option<Tree>,
    pub pending_pattern: Pattern,
    pub total_search_required: bool,
}

An application state dedicated to displaying a tree. It's the first and main screen of broot.

Fields

tree: Tree

filtered_tree: Option<Tree>

pending_pattern: Pattern

total_search_required: bool

Implementations

impl BrowserState

pub fn new(
    path: PathBuf,
    options: TreeOptions,
    screen: &Screen,
    dam: &Dam
) -> Result<Option<BrowserState>, TreeBuildError>

pub fn with_new_options(
    &self,
    screen: &Screen,
    change_options: &dyn Fn(&mut TreeOptions)
) -> AppStateCmdResult

pub fn page_height(screen: &Screen) -> i32

pub fn displayed_tree(&self) -> &Tree

return a reference to the currently displayed tree, which is the filtered tree if there's one, the base tree if not.

pub fn displayed_tree_mut(&mut self) -> &mut Tree

return a mutable reference to the currently displayed tree, which is the filtered tree if there's one, the base tree if not.

pub fn open_selection_stay_in_broot(
    &mut self,
    screen: &mut Screen,
    _con: &AppContext
) -> Result<AppStateCmdResult, ProgramError>

pub fn open_selection_quit_broot(
    &mut self,
    screen: &mut Screen,
    con: &AppContext
) -> Result<AppStateCmdResult, ProgramError>

pub fn go_to_parent(&mut self, screen: &mut Screen) -> AppStateCmdResult

Trait Implementations

impl AppState for BrowserState

fn has_pending_task(&self) -> bool

fn write_status(
    &self,
    w: &mut dyn Write,
    cmd: &Command,
    screen: &Screen,
    con: &AppContext
) -> Result<(), ProgramError>

fn can_execute(&self, verb_index: usize, con: &AppContext) -> bool

fn apply(
    &mut self,
    cmd: &mut Command,
    screen: &mut Screen,
    con: &AppContext
) -> Result<AppStateCmdResult, ProgramError>

fn do_pending_task(&mut self, screen: &mut Screen, dam: &mut Dam)

do some work, totally or partially, if there's some to do. Stop as soon as the dam asks for interruption

fn display(
    &mut self,
    w: &mut dyn Write,
    screen: &Screen,
    _con: &AppContext
) -> Result<(), ProgramError>

fn refresh(&mut self, screen: &Screen, _con: &AppContext) -> Command

fn write_flags(
    &self,
    w: &mut dyn Write,
    screen: &mut Screen,
    _con: &AppContext
) -> Result<(), ProgramError>

draw the flags at the bottom right of the screen

impl VerbExecutor for BrowserState

fn execute_verb(
    &mut self,
    verb: &Verb,
    invocation: &VerbInvocation,
    screen: &mut Screen,
    con: &AppContext
) -> Result<AppStateCmdResult, ProgramError>