Skip to content

Support static string as key value #486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KodrAus merged 1 commit into from
Mar 2, 2022
Merged

Support static string as key value #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/macros.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@
#[macro_export(local_inner_macros)]
macro_rules! log {
// log!(target: "my_target", Level::Info; key1 = 42, key2 = true; "a {} event", "log");
(target: $target:expr, $lvl:expr, $($key:ident = $value:expr),+; $($arg:tt)+) => ({
(target: $target:expr, $lvl:expr, $($key:tt = $value:expr),+; $($arg:tt)+) => ({
Copy link
Copy Markdown
Contributor

@KodrAus KodrAus Feb 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh unfortunately I think this will include quotes in string keys. So for "string/key" the actual string we get will look like "\"string/key\"".

Looking at this again though, I don't think we actually need a tt muncher yet afterall. We can just use another macro around __log_stringify! (or just re-use __log_stringify! for it) that matches on literals and idents and handles them appropriately.

Copy link
Copy Markdown
Collaborator Author

@Thomasdezeeuw Thomasdezeeuw Feb 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, this means the tests I've added are also flawed as they should have caught this.

Copy link
Copy Markdown
Collaborator Author

@Thomasdezeeuw Thomasdezeeuw Feb 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've fixed this in __log_key, formerly __log_stringify, see https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=5daa3859e6f8a8e1245db028199687d9.

let lvl = $lvl;
if lvl <= $crate::STATIC_MAX_LEVEL && lvl <= $crate::max_level() {
$crate::__private_api_log(
__log_format_args!($($arg)+),
lvl,
&($target, __log_module_path!(), __log_file!(), __log_line!()),
Some(&[$((__log_stringify!($key), &$value)),+])
Some(&[$((__log_key!($key), &$value)),+])
);
}
});
Expand Down Expand Up @@ -268,8 +268,13 @@ macro_rules! __log_line {

#[doc(hidden)]
#[macro_export]
macro_rules! __log_stringify {
($($args:tt)*) => {
macro_rules! __log_key {
// key1 = 42
($($args:ident)*) => {
stringify!($($args)*)
};
// "key1" = 42
($($args:expr)*) => {
$($args)*
};
}
10 changes: 10 additions & 0 deletions tests/macros.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,3 +205,13 @@ fn kv_implicit_named_args() {
all_log_macros!(cat_1 = "chashu", cat_2 = "nori", cat_count = 2; "hello {world}");
}
}

#[test]
#[cfg(feature = "kv_unstable")]
fn kv_string_keys() {
for lvl in log::Level::iter() {
log!(target: "my_target", lvl, "also dogs" = "Fílos", "key/that-can't/be/an/ident" = "hi"; "hello {world}", world = "world");
}

all_log_macros!(target: "my_target", "also dogs" = "Fílos", "key/that-can't/be/an/ident" = "hi"; "hello {world}", world = "world");
}