#preview #render #file #display #named-pipe

yanked previuwu

A generic previewer that can preview anything as everything

0.0.0 Jul 24, 2022

#24 in #named-pipe

MIT/Apache

24KB
283 lines

previuwu

A generic previewer that can preview anything as everything.

Uses egui to render the preview window.

STATUS: Proof of Concept (⚠️ heavy work in progress).

https://user-images.githubusercontent.com/11632726/180646344-4cd4e487-9dd9-49a7-9e90-a1baac291124.mp4

Install

Better don't install it as of now, unless you want to contribute.

cargo install --git https://github.com/sayanarijit/previuwu

Usage

Preview a single file:

previuwu /path/to/file

Allow streaming input from stdin:

previuwu /path/to/file --pipe -

Also allow streaming input from a named pipe1:

# mkfifo path/to/input.fifo
previuwu /path/to/file --pipe - --pipe path/to/input.fifo

Use Case

Example usage with xplr:

# Create a fifo file
mkfifo /tmp/xplr.fifo

# Run previuwu in background (will close automatically when done)
previuwu --pipe /tmp/xplr.fifo &

# Run xplr with fifo enabled
xplr --on-load 'StartFifo: /tmp/xplr.fifo'

Supports

I plan to support as many input types as possible.

  • Stdin
  • Named Pipes (fifo)
  • Socket
  • ...ideas?

Very basic (ugly) support for the following file types has been implemented:

  • Directory
  • Text
  • Images
  • ...contribute?

Contribute

First of all, thank you.

Please go through src/preview.rs and try to implement laoding and/or rendering as many file types as you can.

Parsing is the easy part. Rendering might require some experience with egui.

Some files can be really slow to load/render in development mode (cargo run). Try running in release mode (cargo run --release).

Dependencies

~13–22MB
~320K SLoC