lune-org/lune
1
1
Fork 0
mirror of https://github.com/lune-org/lune.git synced 2025-04-04 10:30:54 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add example usage doc to label enum

Browse source
This commit is contained in:
Filip Tibell 2024-04-22 13:00:55 +02:00
parent b04c0c209d
commit 896121ab0d
No known key found for this signature in database
1 changed files with 23 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
crates/lune-utils/src/fmt/label.rs
View file

@ -2,6 +2,24 @@ use std::fmt;
use console::{style, Color};
/**
Label enum used for consistent output formatting throughout Lune.
# Example usage
```rs
use lune_utils::fmt::Label;
println!("{} This is an info message", Label::Info);
// [INFO] This is an info message
println!("{} This is a warning message", Label::Warn);
// [WARN] This is a warning message
println!("{} This is an error message", Label::Error);
// [ERROR] This is an error message
```
*/
#[derive(Debug, Clone, Copy)]
pub enum Label {
Info,
@ -11,14 +29,14 @@ pub enum Label {
impl Label {
/**
Returns the name of the label in lowercase.
Returns the name of the label in all uppercase.
*/
#[must_use]
pub fn name(&self) -> &str {
match self {
Self::Info => "info",
Self::Warn => "warn",
Self::Error => "error",
Self::Info => "INFO",
Self::Warn => "WARN",
Self::Error => "ERROR",
}
}
@ -41,7 +59,7 @@ impl fmt::Display for Label {
f,
"{}{}{}",
style("[").dim(),
style(self.name().to_ascii_uppercase()).fg(self.color()),
style(self.name()).fg(self.color()),
style("]").dim()
)
}