Expose format_into and format_into_io for DelayedFormat
#1653
Conversation
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1653 +/- ##
==========================================
+ Coverage 91.01% 91.03% +0.01%
==========================================
Files 37 37
Lines 17342 17376 +34
==========================================
+ Hits 15784 15818 +34
Misses 1558 1558 ☔ View full report in Codecov by Sentry. |
tugtugtug
force-pushed
the
wip-add-format-into
branch
from
fd20e84 to
c5862a5
Compare
tugtugtug
force-pushed
the
wip-add-format-into
branch
from
c5862a5 to
f5e1579
Compare
tugtugtug
force-pushed
the
wip-add-format-into
branch
from
f5e1579 to
8d789f5
Compare
Request for chronotope#1649 - renamed format to format_into and made it public. - added format_into_io to allow format into a `std::io::Write`. - added unittests - added benchmarks for the 3 methods, `Display`, `format_into`, and `format_into_io`.
tugtugtug
force-pushed
the
wip-add-format-into
branch
from
8d789f5 to
bfdd4d7
Compare
djc
reviewed
Jan 22, 2025
src/format/formatting.rs
Outdated
Comment on lines
100
to
118
| /// Formats `DelayedFormat` into an `std::io::Write` instance. | ||
| /// # Errors | ||
| /// This function returns an error if formatting into the `std::io::Write` instance fails. | ||
| #[cfg(feature = "std")] | ||
| pub fn format_into_io(self, w: &mut impl std::io::Write) -> fmt::Result { | ||
| // wrapper to allow reuse of the existing string based | ||
| // writers | ||
| struct IoWriter<W: std::io::Write> { | ||
| writer: W, | ||
| } | ||
| impl<W: std::io::Write> fmt::Write for IoWriter<W> { | ||
| #[inline] | ||
| fn write_str(&mut self, s: &str) -> fmt::Result { | ||
| self.writer.write_all(s.as_bytes()).map_err(|_| fmt::Error) | ||
| } | ||
| } | ||
| let mut writer = IoWriter { writer: w }; | ||
| self.format_into(&mut writer) | ||
| } |
There was a problem hiding this comment.
Not really interested in taking this. Callers can construct their own adapter if that is important to them.
There was a problem hiding this comment.
made it into an example instead.
src/format/formatting.rs
Outdated
| /// Formats `DelayedFormat` into a `core::fmt::Write` instance. | ||
| /// # Errors | ||
| /// This function returns an error if formatting into the `core::fmt::Write` instance fails. | ||
| pub fn format_into(&self, w: &mut impl Write) -> fmt::Result { |
Request for chronotope#1649 - renamed format to write-to and made it public. - added unittests - added benchmarks to compare and show `Display` is slower than `write_to` in that specific use case.
|
created new pr #1654 with the changes recommended. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Request for #1649
std::io::Write.Display,format_into, andformat_into_io.Thanks for contributing to chrono!
If your feature is semver-compatible, please target the main branch;
for semver-incompatible changes, please target the
0.5.xbranch.Please consider adding a test to ensure your bug fix/feature will not break in the future.