hammy
/
rall
mirror of https://github.com/sgoudham/rall.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from sgoudham/v0.3.0

Browse Source
pull/3/head
Hamothy 3 years ago committed by GitHub
parent 5c636f8bf2 e49920e19f
commit 4d8ed2a4ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 306 additions and 90 deletions
Show Stats Download Patch File Download Diff File

1
Cargo.toml
Unescape Escape View File

@ -12,6 +12,7 @@ categories = ["development-tools::debugging"]
exclude = [".github/**"] exclude = [".github/**"]
[dependencies] [dependencies]
chrono = "0.4.19"
embed-doc-image = "0.1.4" embed-doc-image = "0.1.4"
termcolor = "1.1.3" termcolor = "1.1.3"

22
README.md
Unescape Escape View File

@ -21,19 +21,19 @@ And much more to come... soon™!
## Quick Start ## Quick Start
```rust For the fastest setup possible, declarative macros are exposed that have a predefined format.
use rall::{SimpleLogger, Level}; This is to allow hassle-free and painless setup that will let you log instantly!
// Create Default SimpleLogger ```rust
let mut logger = SimpleLogger::default(); use rall::{debug, error, fatal, info, trace, warn};
// Log Out To Standard Output // Log Out To Standard Output
logger.log(Level::TRACE, "My Best Friend Hazel :D"); trace!("My Best Friend Hazel :D");
logger.log(Level::DEBUG, "My Best Friend Hazel :D"); debug!("My Best Friend Hazel :D");
logger.log(Level::INFO, "My Best Friend Hazel :D"); info!("My Best Friend Hazel :D");
logger.log(Level::WARN, "My Best Friend Hazel :D"); warn!("My Best Friend Hazel :D");
logger.log(Level::ERROR, "My Best Friend Hazel :D"); error!("My Best Friend Hazel :D");
logger.log(Level::FATAL, "My Best Friend Hazel :D"); fatal!("My Best Friend Hazel :D");
``` ```
### Windows Output ### Windows Output
@ -48,4 +48,4 @@ logger.log(Level::FATAL, "My Best Friend Hazel :D");
I'm still incredibly early in my Rust journey and so I wanted to get comfortable and try to pick my own brain about I'm still incredibly early in my Rust journey and so I wanted to get comfortable and try to pick my own brain about
exposing different API's in a Rust crate. I hope to expose an intuitive and easy to understand API design that users can exposing different API's in a Rust crate. I hope to expose an intuitive and easy to understand API design that users can
instantly get started with. instantly get started with.

BIN
images/unix_logs.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.8 KiB

After

Width:  |  Height:  |  Size: 25 KiB

BIN
images/windows_logs.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 25 KiB

358
src/lib.rs
Unescape Escape View File

@ -10,7 +10,7 @@
//! ## Feature Set //! ## Feature Set
//! //!
//! - [x] Logging Levels //! - [x] Logging Levels
//! - [x] Coloured Output //! - [x] Datetime & Coloured Output
//! - [ ] Options for Datetime, Current Function, Line Number, Custom Colours, etc. //! - [ ] Options for Datetime, Current Function, Line Number, Custom Colours, etc.
//! - [ ] Custom Formatting //! - [ ] Custom Formatting
//! - [ ] File support //! - [ ] File support
@ -19,19 +19,19 @@
//! //!
//! ## Quick Start //! ## Quick Start
//! //!
//! ```rust //! For the fastest setup possible, declarative macros are exposed that have a predefined format.
//! use rall::{SimpleLogger, Level}; //! This is to allow hassle-free and painless setup that will let you log instantly!
//! //!
//! // Create Default SimpleLogger //! ```rust
//! let mut logger = SimpleLogger::default(); //! use rall::{debug, error, fatal, info, trace, warn};
//! //!
//! // Log Out To Standard Output //! // Log Out To Standard Output
//! logger.log(Level::TRACE, "My Best Friend Hazel :D"); //! trace!("My Best Friend Hazel :D");
//! logger.log(Level::DEBUG, "My Best Friend Hazel :D"); //! debug!("My Best Friend Hazel :D");
//! logger.log(Level::INFO, "My Best Friend Hazel :D"); //! info!("My Best Friend Hazel :D");
//! logger.log(Level::WARN, "My Best Friend Hazel :D"); //! warn!("My Best Friend Hazel :D");
//! logger.log(Level::ERROR, "My Best Friend Hazel :D"); //! error!("My Best Friend Hazel :D");
//! logger.log(Level::FATAL, "My Best Friend Hazel :D"); //! fatal!("My Best Friend Hazel :D");
//! ``` //! ```
//! //!
#![cfg_attr(feature = "doc-images", #![cfg_attr(feature = "doc-images",
@ -50,90 +50,306 @@ doc = ::embed_doc_image::embed_image!("unix_logs", "images/unix_logs.png")))]
//! ### Author Notes //! ### Author Notes
//! //!
//! I'm still incredibly early in my Rust journey and so I wanted to get comfortable and try to pick //! I'm still incredibly early in my Rust journey and so I wanted to get comfortable and try to pick
//! my own brain about exposing different API's in a Rust crate. I hope to expose an intuitive and //! my own brain about exposing different APIs in a Rust crate. I hope to expose an intuitive and
//! easy to understand API design that users can instantly get started with. //! easy to understand API design that users can instantly get started with.
use std::fmt::{Display, Formatter}; use std::fmt::{Display, Formatter};
use std::io::Write;
use termcolor::{Color, ColorChoice, ColorSpec, StandardStream, WriteColor};
/// TODO /// Represents all the possible logging levels:
///
/// **TRACE**,
/// **DEBUG**,
/// **INFO**,
/// **WARN**,
/// **ERROR**,
/// **FATAL**
pub enum Level { pub enum Level {
/// # Usage
///
/// For fine-grained information, only within rare cases where full visibility of what is
/// happening in your application is needed.
///
/// # Colour
///
/// Blue
TRACE, TRACE,
/// # Usage
///
/// Less granular when compared to [`TRACE`](Level::TRACE) but still more than what is needed
/// for normal use. This should be used for diagnosing issues and/or troubleshooting.
///
/// # Colour
///
/// Green
DEBUG, DEBUG,
/// # Usage
///
/// Standard log level indicating that something has happened, all logs using [`INFO`](Level::INFO)
/// should be _purely informational_ and not require any further investigation.
///
/// # Colour
///
/// White
INFO, INFO,
/// # Usage
///
/// Indicates that something _unexpected_ has happened within the program. This could represent
/// many things such as a problem or a simple disturbance. This should be used when something
/// unexpected has happened BUT the code can still continue to work.
///
/// # Colour
///
/// Yellow
WARN, WARN,
/// # Usage
///
/// Indicates that the program has hit an issue that is preventing one or more functionalities
/// from properly functioning. This should be used when the application is currently displaying
/// incorrect behaviour that _needs_ to get fixed.
///
/// # Colour
///
/// Dark Red
ERROR, ERROR,
/// # Usage
///
/// Indicates that the program has entered a state in which it has lost _critical business
/// functionality_ and cannot be used in production anymore. This should be used when the
/// program is in **URGENT** need of attention and absolutely should not be in a live environment.
///
/// # Colour
///
/// Red
FATAL, FATAL,
} }
impl Display for Level { impl Display for Level {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
match self { match self {
Level::TRACE => write!(f, "[TRACE]"), Level::TRACE => write!(f, "TRACE"),
Level::DEBUG => write!(f, "[DEBUG]"), Level::DEBUG => write!(f, "DEBUG"),
Level::INFO => write!(f, "[INFO]"), Level::INFO => write!(f, "INFO"),
Level::WARN => write!(f, "[WARN]"), Level::WARN => write!(f, "WARN"),
Level::ERROR => write!(f, "[ERROR]"), Level::ERROR => write!(f, "ERROR"),
Level::FATAL => write!(f, "[FATAL]"), Level::FATAL => write!(f, "FATAL"),
} }
} }
} }
/// TODO /// # Usage
pub struct SimpleLogger { ///
standard_stream: StandardStream, /// For fine-grained information, only within rare cases where full visibility of what is
/// happening in your application is needed.
///
/// # Colour
///
/// Blue
///
/// # Example
///
/// ```rust
/// # use rall::trace;
/// trace!("Hazel!");
/// ```
#[macro_export]
macro_rules! trace {
($str:expr) => {{
use std::io::Write;
use termcolor::WriteColor;
let now = chrono::Utc::now().format("%Y-%M-%dT%H:%M:%S%z");
let mut stream = termcolor::StandardStream::stdout(termcolor::ColorChoice::Always);
stream
.set_color(
termcolor::ColorSpec::new()
.set_fg(Some(termcolor::Color::Blue))
.set_bold(true),
)
.unwrap();
writeln!(&mut stream, "[{} {}] {}", now, rall::Level::TRACE, $str).unwrap();
stream.reset().unwrap();
}};
} }
impl Default for SimpleLogger { /// # Usage
fn default() -> Self { ///
Self { /// Less granular when compared to [`TRACE`](Level::TRACE) but still more than what is needed
standard_stream: StandardStream::stdout(ColorChoice::Always), /// for normal use. This should be used for diagnosing issues and/or troubleshooting.
} ///
} /// # Colour
///
/// Green
///
/// # Example
///
/// ```rust
/// # use rall::debug;
/// debug!("Hazel!");
/// ```
#[macro_export]
macro_rules! debug {
($str:expr) => {{
use std::io::Write;
use termcolor::WriteColor;
let now = chrono::Utc::now().format("%Y-%M-%dT%H:%M:%S%z");
let mut stream = termcolor::StandardStream::stdout(termcolor::ColorChoice::Always);
stream
.set_color(
termcolor::ColorSpec::new()
.set_fg(Some(termcolor::Color::Green))
.set_bold(true),
)
.unwrap();
writeln!(&mut stream, "[{} {}] {}", now, rall::Level::DEBUG, $str).unwrap();
stream.reset().unwrap();
}};
} }
/// TODO /// # Usage
impl SimpleLogger { ///
/// TODO /// Standard log level indicating that something has happened, all logs using [`INFO`](Level::INFO)
pub fn new(standard_stream: StandardStream) -> Self { /// should be _purely informational_ and not require any further investigation.
Self { standard_stream } ///
} /// # Colour
///
/// White
///
/// # Example
///
/// ```rust
/// # use rall::info;
/// info!("Hazel!");
/// ```
#[macro_export]
macro_rules! info {
($str:expr) => {
use std::io::Write;
use termcolor::WriteColor;
/// TODO let now = chrono::Utc::now().format("%Y-%M-%dT%H:%M:%S%z");
pub fn log(&mut self, level: Level, str: &str) { let mut stream = termcolor::StandardStream::stdout(termcolor::ColorChoice::Always);
self.set_colour(&level); stream
writeln!(&mut self.standard_stream, "{} {}", level, str).unwrap(); .set_color(
self.standard_stream.reset().unwrap(); termcolor::ColorSpec::new()
} .set_fg(Some(termcolor::Color::White))
.set_bold(true),
)
.unwrap();
writeln!(&mut stream, "[{} {}] {}", now, rall::Level::INFO, $str).unwrap();
stream.reset().unwrap();
};
}
/// TODO /// # Usage
fn set_colour(&mut self, logging_level: &Level) { ///
match logging_level { /// Indicates that something _unexpected_ has happened within the program. This could represent
Level::TRACE => self /// many things such as a problem or a simple disturbance. This should be used when something
.standard_stream /// unexpected has happened BUT the code can still continue to work.
.set_color(ColorSpec::new().set_fg(Some(Color::Blue)).set_bold(true)) ///
.unwrap(), /// # Colour
Level::DEBUG => self ///
.standard_stream /// Yellow
.set_color(ColorSpec::new().set_fg(Some(Color::Green)).set_bold(true)) ///
.unwrap(), /// # Example
Level::INFO => self ///
.standard_stream /// ```rust
.set_color(ColorSpec::new().set_fg(None)) /// # use rall::warn;
.unwrap(), /// warn!("Hazel!");
Level::WARN => self /// ```
.standard_stream #[macro_export]
.set_color(ColorSpec::new().set_fg(Some(Color::Yellow)).set_bold(true)) macro_rules! warn {
.unwrap(), ($str:expr) => {{
Level::ERROR => self use std::io::Write;
.standard_stream use termcolor::WriteColor;
.set_color(ColorSpec::new().set_fg(Some(Color::Red)).set_intense(true))
.unwrap(), let now = chrono::Utc::now().format("%Y-%M-%dT%H:%M:%S%z");
Level::FATAL => self let mut stream = termcolor::StandardStream::stdout(termcolor::ColorChoice::Always);
.standard_stream stream
.set_color(ColorSpec::new().set_fg(Some(Color::Red)).set_bold(true)) .set_color(
.unwrap(), termcolor::ColorSpec::new()
} .set_fg(Some(termcolor::Color::Yellow))
} .set_bold(true),
)
.unwrap();
writeln!(&mut stream, "[{} {}] {}", now, rall::Level::WARN, $str).unwrap();
stream.reset().unwrap();
}};
}
/// # Usage
///
/// Indicates that the program has hit an issue that is preventing one or more functionalities
/// from properly functioning. This should be used when the application is currently displaying
/// incorrect behaviour that _needs_ to get fixed.
///
/// # Colour
///
/// Dark Red
///
/// # Example
///
/// ```rust
/// # use rall::error;
/// error!("Hazel!");
/// ```
#[macro_export]
macro_rules! error {
($str:expr) => {{
use std::io::Write;
use termcolor::WriteColor;
let now = chrono::Utc::now().format("%Y-%M-%dT%H:%M:%S%z");
let mut stream = termcolor::StandardStream::stdout(termcolor::ColorChoice::Always);
stream
.set_color(
termcolor::ColorSpec::new()
.set_fg(Some(termcolor::Color::Red))
.set_intense(true),
)
.unwrap();
writeln!(&mut stream, "[{} {}] {}", now, rall::Level::ERROR, $str).unwrap();
stream.reset().unwrap();
}};
}
/// # Usage
///
/// Indicates that the program has entered a state in which it has lost _critical business
/// functionality_ and cannot be used in production anymore. This should be used when the
/// program is in **URGENT** need of attention and absolutely should not be in a live environment.
///
/// # Colour
///
/// Red
///
/// # Example
///
/// ```rust
/// # use rall::fatal;
/// fatal!("Hazel!");
/// ```
#[macro_export]
macro_rules! fatal {
($str:expr) => {{
use std::io::Write;
use termcolor::WriteColor;
let now = chrono::Utc::now().format("%Y-%M-%dT%H:%M:%S%z");
let mut stream = termcolor::StandardStream::stdout(termcolor::ColorChoice::Always);
stream
.set_color(
termcolor::ColorSpec::new()
.set_fg(Some(termcolor::Color::Red))
.set_bold(true),
)
.unwrap();
writeln!(&mut stream, "[{} {}] {}", now, rall::Level::FATAL, $str).unwrap();
stream.reset().unwrap();
}};
} }

15
src/main.rs
Unescape Escape View File

@ -1,11 +1,10 @@
use rall::{Level, SimpleLogger}; use rall::{debug, error, fatal, info, trace, warn};
fn main() { fn main() {
let mut logger = SimpleLogger::default(); trace!("My Best Friend Hazel :D");
logger.log(Level::TRACE, "My Best Friend Hazel :D"); debug!("My Best Friend Hazel :D");
logger.log(Level::DEBUG, "My Best Friend Hazel :D"); info!("My Best Friend Hazel :D");
logger.log(Level::INFO, "My Best Friend Hazel :D"); warn!("My Best Friend Hazel :D");
logger.log(Level::WARN, "My Best Friend Hazel :D"); error!("My Best Friend Hazel :D");
logger.log(Level::ERROR, "My Best Friend Hazel :D"); fatal!("My Best Friend Hazel :D");
logger.log(Level::FATAL, "My Best Friend Hazel :D");
} }
Write Preview
Loading…
Cancel
Save