Struct broot::browser::BrowserState
source · pub struct BrowserState {
pub tree: Tree,
pub filtered_tree: Option<Tree>,
/* private fields */
}
Expand description
An application state dedicated to displaying a tree. It’s the first and main screen of broot.
Fields§
§tree: Tree
§filtered_tree: Option<Tree>
Implementations§
source§impl BrowserState
impl BrowserState
sourcepub fn new(
path: PathBuf,
options: TreeOptions,
screen: Screen,
con: &AppContext,
dam: &Dam
) -> Result<BrowserState, TreeBuildError>
pub fn new(
path: PathBuf,
options: TreeOptions,
screen: Screen,
con: &AppContext,
dam: &Dam
) -> Result<BrowserState, TreeBuildError>
build a new tree state if there’s no error and there’s no cancellation.
pub fn root(&self) -> &Path
pub fn page_height(screen: Screen) -> usize
sourcepub fn displayed_tree(&self) -> &Tree
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.
sourcepub fn displayed_tree_mut(&mut self) -> &mut Tree
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: Screen,
con: &AppContext,
in_new_panel: bool,
keep_pattern: bool
) -> Result<CmdResult, ProgramError>
pub fn go_to_parent(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool
) -> CmdResult
Trait Implementations§
source§impl PanelState for BrowserState
impl PanelState for BrowserState
source§fn with_new_options(
&mut self,
screen: Screen,
change_options: &dyn Fn(&mut TreeOptions) -> &'static str,
in_new_panel: bool,
con: &AppContext
) -> CmdResult
fn with_new_options(
&mut self,
screen: Screen,
change_options: &dyn Fn(&mut TreeOptions) -> &'static str,
in_new_panel: bool,
con: &AppContext
) -> CmdResult
build a cmdResult asking for the addition of a new state being a browser state similar to the current one but with different options
source§fn do_pending_task(
&mut self,
app_state: &mut AppState,
screen: Screen,
con: &AppContext,
dam: &mut Dam
) -> Result<(), ProgramError>
fn do_pending_task(
&mut self,
app_state: &mut AppState,
screen: Screen,
con: &AppContext,
dam: &mut Dam
) -> Result<(), ProgramError>
do some work, totally or partially, if there’s some to do. Stop as soon as the dam asks for interruption
source§fn tree_root(&self) -> Option<&Path>
fn tree_root(&self) -> Option<&Path>
must return None if the state doesn’t display a file tree
fn get_type(&self) -> PanelStateType
fn set_mode(&mut self, mode: Mode)
fn get_mode(&self) -> Mode
fn get_pending_task(&self) -> Option<&'static str>
fn selected_path(&self) -> Option<&Path>
fn selection(&self) -> Option<Selection<'_>>
fn tree_options(&self) -> TreeOptions
source§fn clear_pending(&mut self)
fn clear_pending(&mut self)
called on start of on_command
fn on_click(
&mut self,
_x: u16,
y: u16,
_screen: Screen,
_con: &AppContext
) -> Result<CmdResult, ProgramError>
fn on_double_click(
&mut self,
_x: u16,
y: u16,
screen: Screen,
con: &AppContext
) -> Result<CmdResult, ProgramError>
fn on_pattern(
&mut self,
pat: InputPattern,
_app_state: &AppState,
_con: &AppContext
) -> Result<CmdResult, ProgramError>
source§fn on_internal(
&mut self,
w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
trigger_type: TriggerType<'_>,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
fn on_internal(
&mut self,
w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
trigger_type: TriggerType<'_>,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
execute the internal with the optional given invocation. Read more
source§fn no_verb_status(&self, has_previous_state: bool, con: &AppContext) -> Status
fn no_verb_status(&self, has_previous_state: bool, con: &AppContext) -> Status
return the status which should be used when there’s no verb edited
fn display(
&mut self,
w: &mut W,
disc: &DisplayContext<'_>
) -> Result<(), ProgramError>
fn refresh(&mut self, screen: Screen, con: &AppContext) -> Command
fn get_starting_input(&self) -> String
fn on_mode_verb(&mut self, mode: Mode, con: &AppContext) -> CmdResult
source§fn on_internal_generic(
&mut self,
_w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
_trigger_type: TriggerType<'_>,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
fn on_internal_generic(
&mut self,
_w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
_trigger_type: TriggerType<'_>,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
a generic implementation of on_internal which may be
called by states when they don’t have a specific
behavior to execute
fn stage(
&self,
app_state: &mut AppState,
cc: &CmdContext<'_>,
con: &AppContext
) -> CmdResult
fn unstage(
&self,
app_state: &mut AppState,
cc: &CmdContext<'_>,
_con: &AppContext
) -> CmdResult
fn toggle_stage(
&self,
app_state: &mut AppState,
cc: &CmdContext<'_>,
con: &AppContext
) -> CmdResult
fn execute_verb(
&mut self,
w: &mut W,
verb: &Verb,
invocation: Option<&VerbInvocation>,
trigger_type: TriggerType<'_>,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
fn execute_external(
&mut self,
w: &mut W,
verb: &Verb,
external_execution: &ExternalExecution,
invocation: Option<&VerbInvocation>,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
fn execute_sequence(
&mut self,
_w: &mut W,
verb: &Verb,
seq_ex: &SequenceExecution,
invocation: Option<&VerbInvocation>,
app_state: &mut AppState,
_cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
source§fn on_command(
&mut self,
w: &mut W,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
fn on_command(
&mut self,
w: &mut W,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
change the state, does no rendering
source§fn open_preview(
&mut self,
prefered_mode: Option<PreviewMode>,
close_if_open: bool,
cc: &CmdContext<'_>
) -> CmdResult
fn open_preview(
&mut self,
prefered_mode: Option<PreviewMode>,
close_if_open: bool,
cc: &CmdContext<'_>
) -> CmdResult
return a cmdresult asking for the opening of a preview