fmt: support formatting Timestamp with a specific offset
#122
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
This makes it possible to format a `Timestamp` with a specific offset. This was already technically possible with the `strftime` API, but adding explicit support for it to the `jiff::fmt::temporal` module seems like good sense. Note that no dedicated parsing routine is added for this because it is already supported automatically.
These are just on the config settings. In newer versions of Rust, I'd expect these to get cross-crate inlined since they are trivial. And of course, when used in a const context, it doesn't matter if they get inlined. But these really should always be inlined, so add the annotation to allow it in contexts where they might otherwise not. I was tempted to add inline annotations to basically every other parse/print routine as well, but I didn't want to overdo it without a more compelling motivation.
I think this is a big ergonomic win for a very common case. It makes using the datetime and span printers much nicer, and they are necessary to use in some cases when the output format needs more configuration.
This mimics the previous commit, but for the RFC 2822 datetime printer.
This provides a more convenient and more easily discoverable interface to `jiff::fmt::temporal::DateTimePrinter::print_timestamp_with_offset`.
BurntSushi
changed the title
BurntSushi
changed the title
Timestamp with a specific offset
This lets us test Rust snippets in the CHANGELOG, which is nice. And it lets us include the CHANGELOG in the rustdoc output itself, thereby hopefully increasing visibility.
This was an oversight. Jiff now has two duration types, so this section basically needed to be entirely rewritten.
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.
This PR does a couple things.
First, it adds a new
jiff::fmt::DateTimePrinter::print_timestamp_with_offsetroutine forformatting a
jiff::Timestampas an RFC 3339 string with a specificoffset. In particular, this draws a contrast between the existing
print_timestampmethod which will always use Zulu time. (Zulu is UTC,but where the offset is unknown.)
Secondly, we add new helper methods on the datetime and span printers
to format datetimes and spans directly into a string. This is just
for convenience, since otherwise creating a
Stringand passingit in as a buffer can be a bit annoying. Also, since it's fixed to
a
String, these methods are infallible and can never fail, whichfurther simplifies their use.