[][src]Crate broot

Modules

app

broot's app is mainly a stack of AppState. Commands parsed from the input are submitted to the current appstate, which replies with a stateCmdResult which may be

app_context
app_state
browser_states
browser_verbs
cli
command_parsing

this mod achieves the transformation of a string containing one or several commands into a vec of parsed commands, using the verbstore to try guess what part is an argument and what part is a filter

commands

A command is the parsed representation of what the user types in the input. It's independant of the state of the application (verbs arent checked at this point)

conf

manage reading the verb shortcuts from the configuration file, initializing if if it doesn't yet exist

displayable_tree
errors

Definitions of custom errors used in broot

external
file_sizes
flat_tree
fuzzy_patterns

a simple fuzzy pattern matcher for filename filtering / sorting. It's not meant for file contents but for small strings (less than 1000 chars) such as file names.

git_ignore

Implements parsing and applying .gitignore files. Also manages a stack of such files, because more than one can apply for a dir (i.e when entering a directory we may add a gitignore file to the stack)

help_content
help_states
help_verbs

this modules defines the execution of verbs on the help screen

io
keys

parsing keys from strings, and describing keys in strings

mad_skin
matched_string
patterns

a pattern for filtering and sorting filenames. It's backed either by a fuzzy pattern matcher or by a regular expression (in which case there's no real score)

permissions
regex_patterns

a filename filtering pattern using a regular expression

screens
selection_type
shell_install
skin
skin_conf
status
task_sync
tree_build
tree_options
verb_conf
verb_invocation
verb_store
verbs