Files
adler32
ahash
aho_corasick
ansi_term
antidote
anyhow
arc_swap
arrayvec
async_speed_limit
async_stream
async_stream_impl
async_trait
atty
aws
backtrace
backtrace_sys
backup
base64
batch_system
bitfield
bitflags
block_buffer
boolinator
bstr
byteorder
bytes
bzip2_sys
cargo_metadata
cdc
cfg_if
chrono
chrono_tz
clap
cloud
codec
collections
concurrency_manager
configuration
configuration_derive
const_fn
const_random
const_random_macro
coprocessor_plugin_api
cpuid_bool
crc32fast
crc64fast
crossbeam
crossbeam_channel
crossbeam_deque
crossbeam_epoch
crossbeam_queue
crossbeam_skiplist
crossbeam_utils
crypto_mac
darling
darling_core
darling_macro
dashmap
debugid
derive_more
digest
dirs
dirs_sys
doc_comment
dtoa
either
encoding_rs
encryption
encryption_export
engine_panic
engine_rocks
engine_test
engine_traits
engine_traits_tests
error_code
error_code_gen
example_plugin
external_storage
external_storage_export
fail
failure
failure_derive
farmhash
file_system
filetime
flate2
fnv
foreign_types
foreign_types_shared
fs2
futures
futures_channel
futures_core
futures_executor
futures_io
futures_macro
futures_sink
futures_task
futures_timer
futures_util
async_await
compat
future
io
lock
sink
stream
task
fuzz
fxhash
gcp
generic_array
getrandom
getset
grpcio
grpcio_health
grpcio_sys
h2
heck
hex
hmac
http
http_body
httparse
httpdate
hyper
hyper_openssl
hyper_tls
ident_case
idna
indexmap
inferno
inotify
inotify_sys
instant
into_other
iovec
ipnet
ipnetwork
itertools
itoa
keys
kvproto
lazy_static
lazycell
libc
libflate
libflate_lz77
libloading
librocksdb_sys
libtitan_sys
libz_sys
linked_hash_map
linked_hash_set
lock_api
log
log_wrappers
lz4_sys
match_template
matches
md5
memchr
memmap
memoffset
memory_trace_macros
mime
mime_guess
mio
mio_extras
mio_uds
more_asserts
murmur3
native_tls
net2
nix
nodrop
nom
notify
num
num_complex
num_cpus
num_derive
num_format
num_integer
num_iter
num_rational
num_traits
once_cell
opaque_debug
openssl
openssl_probe
openssl_sys
ordered_float
panic_hook
parking_lot
parking_lot_core
paste
paste_impl
pd_client
percent_encoding
pest
pin_project
pin_project_lite
pin_utils
pnet_base
pnet_datalink
pnet_sys
pprof
ppv_lite86
proc_macro2
proc_macro_error
proc_macro_error_attr
proc_macro_hack
proc_macro_nested
procfs
procinfo
profiler
prometheus
prometheus_static_metric
promptly
prost
prost_derive
protobuf
quick_xml
quote
raft
raft_engine
raft_log_engine
raft_proto
raftstore
rand
rand_chacha
rand_core
rand_isaac
rayon
rayon_core
regex
regex_automata
regex_syntax
remove_dir_all
reqwest
resolved_ts
rev_lines
rgb
ring
rle_decode_fast
rocksdb
rusoto_core
rusoto_credential
rusoto_kms
rusoto_s3
rusoto_signature
rusoto_sts
rustc_demangle
rustyline
ryu
safemem
same_file
scopeguard
security
semver
semver_parser
serde
serde_derive
serde_ignored
serde_json
serde_urlencoded
serde_with
serde_with_macros
server
sha2
shlex
signal
signal_hook_registry
slab
slog
slog_async
slog_derive
slog_global
slog_json
slog_term
smallvec
snappy_sys
socket2
spin
sst_importer
stable_deref_trait
standback
static_assertions
str_stack
strsim
structopt
structopt_derive
strum
strum_macros
subtle
symbolic_common
symbolic_demangle
syn
syn_mid
synstructure
sysinfo
take_mut
tame_gcs
tame_oauth
tempfile
term
test_backup
test_coprocessor
test_pd
test_raftstore
test_sst_importer
test_storage
test_util
textwrap
thiserror
thiserror_impl
thread_local
tidb_query_aggr
tidb_query_codegen
tidb_query_common
tidb_query_datatype
tidb_query_executors
tidb_query_expr
tikv
coprocessor
coprocessor_v2
import
server
storage
tikv_alloc
tikv_ctl
tikv_jemalloc_ctl
tikv_jemalloc_sys
tikv_jemallocator
tikv_kv
tikv_server
tikv_util
time
time_macros
time_macros_impl
tipb
tipb_helper
tokio
fs
future
io
loom
macros
net
park
process
runtime
signal
stream
sync
task
time
util
tokio_executor
tokio_macros
tokio_openssl
tokio_timer
tokio_tls
tokio_util
toml
tower_service
tracing
tracing_core
try_lock
twoway
twox_hash
txn_types
typenum
ucd_trie
unchecked_index
unicase
unicode_bidi
unicode_normalization
unicode_segmentation
unicode_width
unicode_xid
untrusted
url
utf8parse
uuid
vec_map
vlog
walkdir
want
xml
yatp
zeroize
zstd_sys
  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
#![cfg_attr(feature = "cargo-clippy", deny(clippy))]
#![deny(missing_debug_implementations, missing_docs, warnings)]

//! # vlog
//!
//! Macros to do stdout / stderr logs based on verbosity level.
//!
//! Useful for CLI applications. The default verbosity level is 0, and the
//! supported max verbosity level is 3, which is equivalent to `-vvv` flags seen
//! in most Linux CLI applications.
//!
//! # Example
//! ```
//! #[macro_use]
//! extern crate vlog;
//!
//! use vlog::{get_verbosity_level, set_verbosity_level};
//!
//! fn main() {
//!     // default verbosity level is 0
//!     assert_eq!(0, get_verbosity_level());
//!
//!     v0!("v0 stdout prints");
//!     v1!("v1 stdout won't print");
//!     v2!("v2 stdout won't print");
//!     v3!("v3 stdout won't print");
//!
//!     // set custom verbosity level
//!     set_verbosity_level(1);
//!     assert_eq!(1, get_verbosity_level());
//!
//!     v0!("{} stdout prints", "v0");
//!     v1!("{} stdout prints", "v1");
//!     v2!("{} stdout won't print", "v2");
//!     v3!("{} stdout won't print", "v3");
//!
//!     // set custom max verbosity level
//!     set_verbosity_level(3);
//!     assert_eq!(3, get_verbosity_level());
//!
//!     v0!("{} stdout prints", "v0");
//!     v1!("{} stdout prints", "v1");
//!     v2!("{} stdout prints", "v2");
//!     v3!("{} stdout prints", "v3");
//!
//!     // stderr macros also available
//!     ve0!("{} stderr prints", "ve0");
//!     ve1!("{} stderr prints", "ve1");
//!     ve2!("{} stderr prints", "ve2");
//!     ve3!("{} stderr prints", "ve3");
//! }
//! ```

#[macro_use]
mod macros;

#[cfg(test)]
mod tests;

use std::sync::atomic::{AtomicUsize, Ordering};

/// Application verbosity level value.
static mut VERBOSITY_LEVEL: AtomicUsize = AtomicUsize::new(0);

/// Sets the application verbosity level atomically. This method is thread-safe.
///
/// # Arguments
/// * `verbosity_level` - Verbosity level value. While there is no check on the
/// upper bound, the expected max level value is 3.
///
/// # Example
/// ```
/// use vlog::set_verbosity_level;
///
/// // min verbosity level
/// set_verbosity_level(0);
///
/// // max verbosity level
/// set_verbosity_level(3);
/// ```
#[inline]
pub fn set_verbosity_level(verbosity_level: usize) {
    unsafe { VERBOSITY_LEVEL.store(verbosity_level, Ordering::Relaxed) }
}

/// Gets the application verbosity level atomically. This method is thread-safe.
///
/// # Example
/// ```
/// use vlog::{get_verbosity_level, set_verbosity_level};
///
/// // default verbosity level
/// assert_eq!(0, get_verbosity_level());
///
/// // custom verbosity level
/// set_verbosity_level(1);
/// assert_eq!(1, get_verbosity_level());
/// ```
#[inline]
pub fn get_verbosity_level() -> usize {
    unsafe { VERBOSITY_LEVEL.load(Ordering::Relaxed) }
}