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

#![deny(missing_docs)]
#![deny(clippy::all)]
#![deny(clippy::pedantic)]
#![allow(clippy::unused_self)]
#![allow(clippy::needless_doctest_main)]

//! A flexible and easy-to-use logger that writes logs to stderr and/or to files

//! or other output streams.

//!

//! To read the log specification from an environment variable and get the log written to `stderr`,

//! start `flexi_logger` e.g. like this:

//! ```rust

//! flexi_logger::Logger::with_env().start().unwrap();

//! ```

//!

//! See

//!

//! * [Logger](struct.Logger.html) for a full description of all configuration options,

//! * and the [writers](writers/index.html) module for the usage of additional log writers,

//! * and [the homepage](https://crates.io/crates/flexi_logger) for how to get started.

//!

//! There are configuration options to e.g.

//!

//! * decide whether you want to write your logs to stderr or to a file,

//! * configure the path and the filenames of the log files,

//! * use file rotation,

//! * specify the line format for the log lines,

//! * define additional log output streams, e.g for alert or security messages,

//! * support changing the log specification while the program is running,

//!

//! `flexi_logger` uses a similar syntax as [`env_logger`](http://crates.io/crates/env_logger/)

//! for specifying which logs should really be written (but is more graceful with the syntax,

//! and can provide error information).

//!

//! By default, i.e. if feature `colors` is not switched off, the log lines that appear on your

//! terminal are coloured. In case the chosen colors don't fit to your terminal's color theme,

//! you can adapt the colors to improve readability.

//! See the documentation of method [style](fn.style.html)

//! for a description how this can be done.


mod deferred_now;
mod flexi_error;
mod flexi_logger;
mod formats;
mod log_specification;
mod logger;
mod parameters;
mod primary_writer;
mod reconfiguration_handle;

pub mod writers;

/// Re-exports from log crate

pub use log::{Level, LevelFilter, Record};

pub use crate::deferred_now::DeferredNow;
pub use crate::flexi_error::FlexiLoggerError;
pub use crate::formats::*;
pub use crate::log_specification::{LogSpecBuilder, LogSpecification, ModuleFilter};
pub use crate::logger::{Duplicate, LogTarget, Logger};
pub use crate::parameters::{Age, Cleanup, Criterion, Naming};
pub use crate::reconfiguration_handle::ReconfigurationHandle;