Struct FM 

pub struct FM { /* private fields */ }

Holds everything about the application itself. Dropping the instance of FM allows to write again to stdout. It should be ran like this : crate::app::Fm::start().run().quit().

The application is split into several components:

• a reader of FmEvents,
• a dispatcher of said events,
• the state of the application itself, which is mutated by the dispatcher,
• a displayer which holds a non mutable reference to the state. The displayer can emits events to force state change if needs be.
• a refresher which is used to force a refresh state + display if something happened externally or in some running thread.

Implementations

impl FM

pub fn start() -> Result<Self>

Setup everything the application needs in its main loop : a panic hook for graceful panic and displaying a traceback for debugging purpose, an EventReader, an EventDispatcher, a Status, a Display, a Refresher. It reads and drops the configuration from the config file. If the config can’t be parsed, it exits with error code 1.

Errors

May fail if the ratatui::DefaultTerminal can’t be started or crashes

pub fn exit_wrong_config() -> !

Exit the application and log a message. Used when the config can’t be read.

pub fn run(self) -> Result<Self>

Run the update status loop and returns itself after completion.

pub fn quit(self) -> Result<()>

Reset everything as best as possible, stop any long thread in a loop and exit.

More specifically :

• Display the cursor,
• drop itself, which allow us to print normally afterward
• print the final path

Errors

May fail if the terminal crashes May also fail if the thread running in crate::app::Refresher crashed