Expose Writer::new as public #2525
Conversation
Solves tokio-rs#2512 I'm writing a custom formatting layer and want to use UtcTime and format_time to format the time into a string.
| // constructors instead (e.g. `from_string` that stores whether the string | ||
| // is empty...?) | ||
| pub(crate) fn new(writer: &'writer mut impl fmt::Write) -> Self { | ||
| pub fn new(writer: &'writer mut impl fmt::Write) -> Self { |
There was a problem hiding this comment.
If we're going to make this a public API, it should have API documentation.
Also, since it's a constructor, let's add
| pub fn new(writer: &'writer mut impl fmt::Write) -> Self { | |
| #[must_use] | |
| pub fn new(writer: &'writer mut impl fmt::Write) -> Self { |
to ensure that the returned value is not accidentally discarded.
There was a problem hiding this comment.
How does one add the documentation? I can do this if no one else has the time. I don't know too much about how this process works (just doc comments?), or whatever second and third degree affects might need to be documented.
|
Any update on this? I have this implemented in my own fork, but for some reason other crates that use a different version no longer work with the global subscriber, so getting this officially implemented would be great! I can make a new merge request with comments, but I'm not sure of all the considerations that need to be taken into account. |
|
Any update on this? |
|
Is there any way to yet again request eyes on this/the new PR (#2680)/the issue (#2512)? This minor change not being handled has blocked my ability to update :/ I do understand no one is under any obligation to spend their time working on this, but the new PR does resolve the comments here and seems to have been completely ignored. Hopefully putting in an extra ping is a valid reminder. |
Hi, I've reviewed the new PR, #2680. Hopefully we can get that merged soon. Sorry I didn't address this sooner --- I'm more or less the only maintainer of all the |
## Motivation As seen here #2512 and #2223. Previously pr'ed here #2525, but no progress has been made there for quite some. I have applied the suggested changes. Not sure the formatting of the doc is sufficient or otherwise correct ## Solution Make the `format::Writer::new()` function public. I don't see any obvious trade-offs, but I am not familiar with the larger direction of tracing/subscriber, so I may be wrong. Closes #2512 Closes #2223 Co-authored-by: Cephas Storm <[email protected]> Co-authored-by: Eliza Weisman <[email protected]>
|
Don't worry at all! I totally get it. FOSS can be a busy mess. I appreciate all the work you do, just wanted to do what I can to help move things forward :) Thanks for handling this! |
## Motivation As seen here #2512 and #2223. Previously pr'ed here #2525, but no progress has been made there for quite some. I have applied the suggested changes. Not sure the formatting of the doc is sufficient or otherwise correct ## Solution Make the `format::Writer::new()` function public. I don't see any obvious trade-offs, but I am not familiar with the larger direction of tracing/subscriber, so I may be wrong. Closes #2512 Closes #2223 Co-authored-by: Cephas Storm <[email protected]> Co-authored-by: Eliza Weisman <[email protected]>
## Motivation As seen here #2512 and #2223. Previously pr'ed here #2525, but no progress has been made there for quite some. I have applied the suggested changes. Not sure the formatting of the doc is sufficient or otherwise correct ## Solution Make the `format::Writer::new()` function public. I don't see any obvious trade-offs, but I am not familiar with the larger direction of tracing/subscriber, so I may be wrong. Closes #2512 Closes #2223 Co-authored-by: Cephas Storm <[email protected]> Co-authored-by: Eliza Weisman <[email protected]>
## Motivation As seen here tokio-rs#2512 and tokio-rs#2223. Previously pr'ed here tokio-rs#2525, but no progress has been made there for quite some. I have applied the suggested changes. Not sure the formatting of the doc is sufficient or otherwise correct ## Solution Make the `format::Writer::new()` function public. I don't see any obvious trade-offs, but I am not familiar with the larger direction of tracing/subscriber, so I may be wrong. Closes tokio-rs#2512 Closes tokio-rs#2223 Co-authored-by: Cephas Storm <[email protected]> Co-authored-by: Eliza Weisman <[email protected]>
|
This can be closed as #2680 has been merged. |
Solves #2512
I'm writing a custom formatting layer and want to use UtcTime and format_time to format the time into a string.