Module broot::display

source ·
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

Modules

Macros

  • declare a style named $dst which is usually a reference to the $src skin but, in case selected is true, is a clone with background changed to the one of selected lines.

Structs

  • 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
  • A tree wrapper which can be used either
  • A value which is initialized on the first access.
  • an object which writes file permissions (mode, owner, group)
  • The dimensions of the screen

Enums

Constants

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

Statics

Traits

  • A data structure that can be deserialized from any data format supported by Serde.
  • Adds the is_tty method to types that might represent a terminal

Functions

  • 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)
  • Return the light of the terminal background, which is a value between 0 (black) and 1 (white).
  • return a Cols which tries to take the s setting into account but is guaranteed to have every Col exactly once.
  • return a Cols which tries to take the s setting into account but is guaranteed to have every Col exactly once.
  • return the writer used by the application

Type Definitions

  • the type used by all GUI writing functions

Derive Macros