Module broot::display[][src]

Expand description

This module is where is defined whether broot writes on stdout, on stderr or elsewhere. It also provides helper structs for io.

Re-exports

pub use cond_bg;

Modules

flags_display
status_line

Structs

Areas

the areas of the various parts of a panel. It’s also where a state usually checks how many panels there are, and their respective positions

CropWriter

wrap a writer to ensure that at most allowed columns are written.

DisplayableTree

A tree wrapper which can be used either

Filling
GitStatusDisplay
MatchedString
PermWriter

an object which writes file permissions (mode, owner, group)

Screen

The dimensions of the screen

Enums

Col

One of the “columns” of the tree view

ColsConf

Constants

WIDE_STATUS

if true then the status of a panel covers the whole width of the terminal (over the other panels)

Statics

BRANCH_FILLING
DEFAULT_COLS

Default column order

SPACE_FILLING
TAB_REPLACEMENT

Functions

cell_size_in_pixels

find and return the size of a cell (a char location) in pixels as (width, height). Many terminals don’t fill this information correctly, so an error is expected (it works on kitty, where I use the data to compute the rendering dimensions of images)

fill_bg
parse_cols

return a Cols which tries to take the s setting into account but is guaranteed to have every Col exactly once.

parse_cols_single_str

return a Cols which tries to take the s setting into account but is guaranteed to have every Col exactly once.

writer

return the writer used by the application

Type Definitions

Cols
W

the type used by all GUI writing functions