Enum broot::preview::Preview

pub enum Preview {
    Image(ImageView),
    Syntactic(SyntacticView),
    Hex(HexView),
    ZeroLen(ZeroLenFileView),
    IoError(Error),
}

Variants

Image(ImageView)

Tuple Fields of Image

0: ImageView

Syntactic(SyntacticView)

Tuple Fields of Syntactic

0: SyntacticView

Hex(HexView)

Tuple Fields of Hex

0: HexView

ZeroLen(ZeroLenFileView)

Tuple Fields of ZeroLen

0: ZeroLenFileView

IoError(Error)

Tuple Fields of IoError

0: Error

Implementations

impl Preview

pub fn new(
    path: &Path,
    prefered_mode: Option<PreviewMode>,
    con: &AppContext
) -> Self

build a preview, never failing (but the preview can be Preview::IOError). If the prefered mode can’t be applied, an other mode is chosen.

pub fn with_mode(
    path: &Path,
    mode: PreviewMode,
    con: &AppContext
) -> Result<Self, ProgramError>

try to build a preview with the designed mode, return an error if that wasn’t possible

pub fn image(path: &Path) -> Self

build an image view, unless the file can’t be interpreted as an image, in which case a hex view is used

pub fn unfiltered_text(path: &Path, con: &AppContext) -> Self

build a text preview (maybe with syntaxic coloring) if possible, a hex (binary) view if content isnt’t UTF8, a ZeroLen file if there’s no length (it’s probably a linux pseudofile) or a IOError when there’s a IO problem

pub fn filtered(
    &self,
    path: &Path,
    pattern: InputPattern,
    dam: &mut Dam,
    con: &AppContext
) -> Option<Self>

try to build a filtered text view. Will return None if the dam gets an event before it’s built

pub fn hex(path: &Path) -> Self

return a hex_view, suitable for binary, or Self::IOError if there was an error

pub fn get_mode(&self) -> Option<PreviewMode>

return the preview_mode, or None if we’re on IOError

pub fn pattern(&self) -> InputPattern

pub fn try_scroll(&mut self, cmd: ScrollCommand) -> bool

pub fn is_filterable(&self) -> bool

pub fn get_selected_line(&self) -> Option<String>

pub fn get_selected_line_number(&self) -> Option<LineNumber>

pub fn try_select_line_number(&mut self, number: usize) -> bool

pub fn unselect(&mut self)

pub fn try_select_y(&mut self, y: u16) -> bool

pub fn move_selection(&mut self, dy: i32, cycle: bool)

pub fn select_first(&mut self)

pub fn select_last(&mut self)

pub fn display(
    &mut self,
    w: &mut W,
    screen: Screen,
    panel_skin: &PanelSkin,
    area: &Area,
    con: &AppContext
) -> Result<(), ProgramError>

pub fn display_info(
    &mut self,
    w: &mut W,
    screen: Screen,
    panel_skin: &PanelSkin,
    area: &Area
) -> Result<(), ProgramError>