forestry 1.11.0

A simple cross-platform CLI logging library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

use super::*;

/**
  Configure the logger with options.

  See [Options] for more details.

  # Arguments
  - `opts`: an array of [Options]
  */
#[inline(always)]
pub async fn cfg(c: &[logs::Options<'_>]) -> Res {
    LOG.lock().unwrap().cfg(c).await?;
    Ok(())
}

/**
  Log a message.

  The message is logged as an INFO message.

  # Arguments
  - `s`: The message to log.

  # Example
  ```rust
  use forestry::prelude::*;
  info("info");        // Output: [0000:*] info
  ```
  */
#[inline(always)]
pub async fn info(s: &str) {
    LOG.lock().unwrap().info(s).await;
}

/**
  Log a message.

  The message is logged as a warn message.

  # Arguments
  - `s`: The message to log.

  # Example
  ```rust
  use forestry::prelude::*;
  warn("warn");        // Output: [0000:~] warn
  ```
  */
#[inline(always)]
pub async fn warn(s: &str) {
    LOG.lock().unwrap().warn(s).await;
}

/**
  Log a message.

  The message is logged as an ERROR message.

  # Arguments
  - `s`: The message to log.

  # Example
  ```rust
  use forestry::prelude::*;
  error("error");        // Output: [0000:!] error
  ```
  */
#[inline(always)]
pub async fn error(s: &str) {
    LOG.lock().unwrap().error(s).await;
}

/**
  Log a message.

  The message is logged as a SUCCESS message.

  # Arguments
  - `s`: The message to log.

  # Example
  ```rust
  use forestry::prelude::*;
  success("success");        // Output: [0000:+] success
  ```
  */
#[inline(always)]
pub async fn success(s: &str) {
    LOG.lock().unwrap().success(s).await;
}

/**
  Log a message.

  The message is logged as a DEBUG message.

  # Arguments
  - `s`: The message to log.

  # Example
  ```rust
  use forestry::prelude::*;
  debug("debug");        // Output: [0000:?] debug
  ```
  */
#[inline(always)]
pub async fn debug(s: &str) {
    LOG.lock().unwrap().debug(s).await;
}

/**
  Log a message.

  The message is logged as a CRITICAL message.

  # Arguments
  - `s`: The message to log.

  # Example
  ```rust
  use forestry::prelude::*;
  critical("critical");        // Output: [0000:%] critical
  ```
  */
#[inline(always)]
pub async fn critical(s: &str) {
    LOG.lock().unwrap().critical(s).await;
}