#cursive #debug #logging #terminal #cursive-views

cursive-flexi-logger-view

An alternative debug view for gyscos/cursive using emabee/flexi_logger

7 releases (4 breaking)

0.5.0 Jan 15, 2022
0.4.0 Mar 3, 2021
0.3.0 Aug 8, 2020
0.2.1 Mar 20, 2020
0.1.1 Sep 9, 2019

#457 in Debugging

Download history 3/week @ 2023-11-16 7/week @ 2023-11-23 3/week @ 2023-11-30 2/week @ 2023-12-28 10/week @ 2024-01-04 4/week @ 2024-01-11 1/week @ 2024-01-25 7/week @ 2024-02-08 26/week @ 2024-02-15 51/week @ 2024-02-22 17/week @ 2024-02-29

101 downloads per month
Used in regview

BSD-3-Clause

71KB
262 lines

Welcome to cursive-flexi-logger-view 👋

stable build nightly build crates.io Docs.rs GitHub PRs Welcome
An alternative debug view for gyscos/cursive using emabee/flexi_logger


This project provides a new debug view for gyscos/cursive using the emabee/flexi_logger crate. This enables the FlexiLoggerView to respect the RUST_LOG environment variable as well as the flexi_logger configuration file. Have a look at the demo below to see how it looks.

How does it look like? demo terminalizer

Expand to view flexi-logger-view demo

Usage

Simply add to your Cargo.toml

[dependencies]
cursive-flexi-logger-view = "^0"

Using the FlexiLoggerView

To create a FlexiLoggerView you first have to register the cursive_flexi_logger as a Writer in flexi_logger. After the flexi_logger has started, you may create a FlexiLoggerView instance and add it to cursive.

use cursive::Cursive;
use cursive_flexi_logger_view::FlexiLoggerView;
use flexi_logger::Logger;

fn main() {
    // we need to initialize cursive first, as the cursive-flexi-logger
    // needs a cursive callback sink to notify cursive about screen refreshs
    // when a new log message arrives
    let mut siv = Cursive::default();

    Logger::try_with_env_or_str("trace")
        .expect("Could not create Logger from environment :(")
        .log_to_file_and_writer(
            flexi_logger::FileSpec::default()
                .directory("logs")
                .suppress_timestamp(),
            cursive_flexi_logger_view::cursive_flexi_logger(&siv)
            )
        .format(flexi_logger::colored_with_thread)
        .start()
        .expect("failed to initialize logger!");

    siv.add_layer(FlexiLoggerView::scrollable()); // omit `scrollable` to remove scrollbars

    log::info!("test log message");
    siv.run();
}

Look into the documentation for a detailed explanation on the API.

Troubleshooting

If you find any bugs/unexpected behaviour or you have a proposition for future changes open an issue describing the current behaviour and what you expected.

Development cargo test

Running the tests

Just run

$ cargo test

to execute all available tests.

shields.io endpoints

shields.io endpoints are generated inside the ./target/shields folder. They are used in this README.

Authors

Fin Christensen

:octocat: @fin-ger
🐘 @fin_ger@weirder.earth
🐦 @fin_ger_github


Johannes Wünsche

:octocat: @jwuensche
🐘 @fredowald@mastodon.social
🐦 @Fredowald

Show your support

Give a ⭐ if this project helped you!

Dependencies

~6MB
~104K SLoC