forked from rust-lang/log
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
93 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,117 @@ | ||
//! WARNING: this is not part of the crate's public API and is subject to change at any time | ||
|
||
use self::sealed::KVs; | ||
use crate::{Level, Metadata, Record}; | ||
use std::fmt::Arguments; | ||
pub use std::option::Option; | ||
pub use std::{file, format_args, line, module_path, stringify}; | ||
|
||
#[cfg(feature = "kv_unstable")] | ||
pub type Value<'a> = dyn crate::kv::value::ToValue + 'a; | ||
|
||
#[cfg(not(feature = "kv_unstable"))] | ||
pub fn log( | ||
pub type Value<'a> = str; | ||
|
||
mod sealed { | ||
/// Argument that provides key-value pairs. | ||
pub trait KVs<'a> { | ||
fn into_kvs(self) -> &'a [(&'a str, &'a super::Value<'a>)]; | ||
} | ||
} | ||
|
||
// key values. | ||
|
||
impl<'a> KVs<'a> for &'a [(&'a str, &'a Value<'a>)] { | ||
#[inline] | ||
fn into_kvs(self) -> &'a [(&'a str, &'a Value<'a>)] { | ||
self | ||
} | ||
} | ||
|
||
impl<'a> KVs<'a> for () { | ||
#[inline] | ||
fn into_kvs(self) -> &'a [(&'a str, &'a Value<'a>)] { | ||
&[] | ||
} | ||
} | ||
|
||
// Log implementation. | ||
|
||
fn log_impl( | ||
args: Arguments, | ||
level: Level, | ||
&(target, module_path, file): &(&str, &'static str, &'static str), | ||
line: u32, | ||
kvs: Option<&[(&str, &str)]>, | ||
kvs: &[(&str, &Value)], | ||
) { | ||
if kvs.is_some() { | ||
#[cfg(not(feature = "kv_unstable"))] | ||
if !kvs.is_empty() { | ||
panic!( | ||
"key-value support is experimental and must be enabled using the `kv_unstable` feature" | ||
) | ||
} | ||
|
||
crate::logger().log( | ||
&Record::builder() | ||
.args(args) | ||
.level(level) | ||
.target(target) | ||
.module_path_static(Some(module_path)) | ||
.file_static(Some(file)) | ||
.line(Some(line)) | ||
.build(), | ||
); | ||
let mut builder = Record::builder(); | ||
|
||
builder | ||
.args(args) | ||
.level(level) | ||
.target(target) | ||
.module_path_static(Some(module_path)) | ||
.file_static(Some(file)) | ||
.line(Some(line)); | ||
|
||
#[cfg(feature = "kv_unstable")] | ||
builder.key_values(&kvs); | ||
|
||
crate::logger().log(&builder.build()); | ||
} | ||
|
||
#[cfg(feature = "kv_unstable")] | ||
pub fn log( | ||
pub fn log<'a, K>( | ||
args: Arguments, | ||
level: Level, | ||
&(target, module_path, file): &(&str, &'static str, &'static str), | ||
target_module_path_and_file: &(&'a str, &'static str, &'static str), | ||
line: u32, | ||
kvs: Option<&[(&str, &dyn crate::kv::ToValue)]>, | ||
) { | ||
crate::logger().log( | ||
&Record::builder() | ||
.args(args) | ||
.level(level) | ||
.target(target) | ||
.module_path_static(Some(module_path)) | ||
.file_static(Some(file)) | ||
.line(Some(line)) | ||
.key_values(&kvs) | ||
.build(), | ||
); | ||
kvs: K, | ||
) where | ||
K: KVs<'a>, | ||
{ | ||
log_impl( | ||
args, | ||
level, | ||
target_module_path_and_file, | ||
line, | ||
kvs.into_kvs(), | ||
) | ||
} | ||
|
||
pub fn enabled(level: Level, target: &str) -> bool { | ||
crate::logger().enabled(&Metadata::builder().level(level).target(target).build()) | ||
} | ||
|
||
/// This function is not intended to be actually called by anyone. The intention of this function is for forcing the | ||
/// compiler to generate monomorphizations of the `log` function, so that they can be shared by different downstream | ||
/// crates. | ||
/// | ||
/// The idea is that with [`share-generics`](https://github.com/rust-lang/rust/pull/48779), downstream crates can reuse | ||
/// generic monomorphizations from upstream crates, but not siblings crates. So it is best to instantiate these | ||
/// monomorphizations in the `log` crate, so downstream crates are guaranteed to be able to share these | ||
/// monomorphizations. | ||
pub fn instantiate_log_function() -> usize { | ||
struct State(usize); | ||
|
||
impl State { | ||
fn add<'a, K>(&mut self) | ||
where | ||
K: KVs<'a>, | ||
{ | ||
self.0 ^= log::<K> as usize; | ||
} | ||
} | ||
|
||
let mut state = State(0); | ||
|
||
state.add::<&[(&str, &Value)]>(); | ||
state.add::<()>(); | ||
|
||
state.0 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters