Releases: chronotope/chrono
0.4.39
What's Changed
- #1577: Changed years_since documentation to match its implementation by @Taxalo in #1578
- Remove obsolete weird feature guard by @djc in #1582
- Fix format::strftime docs link by @frederikhors in #1581
- Fix micros (optional) limit in and_hms_micro_opt by @qrilka in #1584
- Update windows-bindgen requirement from 0.56 to 0.57 by @dependabot in #1589
- native/date: Improve DelayedFormat doc re Panics by @behnam-oneschema in #1590
- Fix typo in rustdoc of
from_timestamp_nanos()
by @sgoll in #1591 - Update windows-bindgen requirement from 0.57 to 0.58 by @dependabot in #1594
- docs: document century cutoff for %y by @MarcoGorelli in #1598
- Checked
NaiveWeek
methods by @bragov4ik in #1600 - Impl serde::Serialize and serde::Deserialize for TimeDelta by @Awpteamoose in #1599
- Derive
PartialEq
,Eq
,Hash
,Copy
andClone
onNaiveWeek
by @DSeeLP in #1618 - Support ohos tzdata since ver.oh35 by @MirageLyu in #1613
- Use Formatter::pad (instead of write_str) for Weekdays by @horazont in #1621
- Fix typos by @szepeviktor in #1623
- Fix comment. by @khuey in #1624
- chore: add
#[inline]
tonum_days
by @CommanderStorm in #1627 - fix typo by @futreall in #1633
- Update mod.rs by @donatik27 in #1638
v0.4.38
This release bring a ca. 20% improvement to the performance of the formatting code, and a convenient days_since
method for the Weekday
type.
Chrono 0.4.38 also removes the long deprecated rustc-serialize
feature. Support for rustc-serialize
will be soft-destabilized in the next Rust edition. Removing the feature will not break existing users of the feature; Cargo will just not update dependents that rely on it to newer versions of chrono.
In chrono 0.4.36 we made an accidental breaking change by switching to derive(Copy)
for DateTime
instead of a manual implementation. It is reverted in this release.
Removals
- Remove
rustc-serialize
feature (#1548, thanks @workingjubilee)
Additions
- Add
Weekday::days_since
(#1249, based on #216 by @clarfonthey) - Add
TimeDelta::checked_mul
andTimeDelta::checked_div
(#1565, thanks @Zomtir)
Fixes
- Return error when rounding with a zero duration (#1474, thanks @Dav1dde)
- Manually implement
Copy
forDateTime
if offset isCopy
(#1573)
Internal
- Inline
test_encodable_json
andtest_decodable_json
functions (#1550) - CI: Reduce combinations in
cargo hack check
(#1553) - Refactor formatting code (#1335)
- Optimize number formatting (#1558)
- Only package files needed for building and testing (#1554)
Thanks to all contributors on behalf of the chrono team, @djc and @pitdicker!
v.0.4.8
v0.4.37
Version 0.4.36 introduced an unexpected breaking change and was yanked. In it LocalResult
was renamed to MappedLocalTime
to avoid the impression that it is a Result
type were some of the results are errors. For backwards compatibility a type alias with the old name was added.
As it turns out there is one case where a type alias behaves differently from the regular enum: you can't import enum variants from a type alias with use chrono::LocalResult::*
. With 0.4.37 we make the new name MappedLocalTime
the alias, but keep using it in function signatures and the documentation as much as possible.
See also the release notes of chrono 0.4.36 from yesterday for the yanked release.
v0.4.36
This release un-deprecates the methods on TimeDelta
that were deprecated with the 0.4.35 release because of the churn they are causing for the ecosystem.
New is the DateTime::with_time()
method. As an example of when it is useful:
use chrono::{Local, NaiveTime};
// Today at 12:00:00
let today_noon = Local::now().with_time(NaiveTime::from_hms_opt(12, 0, 0).unwrap());
Additions
- Add
DateTime::with_time()
(#1510)
Deprecations
- Revert
TimeDelta
deprecations (#1543) - Deprecate
TimeStamp::timestamp_subsec_nanos
, which was missed in the 0.4.35 release (#1486)
Documentation
- Correct version number of deprecation notices (#1486)
- Fix some typos (#1505)
- Slightly improve serde documentation (#1519)
- Main documentation: simplify links and reflow text (#1535)
Internal
- CI: Lint benchmarks (#1489)
- Remove unnessary
Copy
andSend
impls (#1492, thanks @erickt) - Backport streamlined
NaiveDate
unit tests (#1500, thanks @Zomtir) - Rename
LocalResult
toTzResolution
, add alias (#1501) - Update windows-bindgen to 0.55 (#1504)
- Avoid duplicate imports, which generate warnings on nightly (#1507)
- Add extra debug assertions to
NaiveDate::from_yof
(#1518) - Some small simplifications to
DateTime::date_naive
andNaiveDate::diff_months
(#1530) - Remove
unwrap
in UnixLocal
type (#1533) - Use different method to ignore feature-dependent doctests (#1534)
Thanks to all contributors on behalf of the chrono team, @djc and @pitdicker!
v0.4.35
Most of our efforts have shifted to improving the API for a 0.5 release, for which cleanups and refactorings are landing on the 0.4.x branch.
The most significant changes in this release are two sets of deprecations.
-
We deprecated all timestamp-related methods on
NaiveDateTime
. The reason is that a timestamp is defined to be in UTC. TheNaiveDateTime
type doesn't know the offset from UTC, so it was technically wrong to have these methods. The alternative is to use the similar methods on theDateTime<Utc>
type, or from theTimeZone
trait.Converting from
NaiveDateTime
toDateTime<Utc>
is simple with.and_utc()
, and in the other direction with.naive_utc()
. -
The panicking constructors of
TimeDelta
(the new name of theDuration
type) are deprecated. This was the last part of chrono that defaulted to panicking on error, dating from before rust 1.0. -
A nice change is that
NaiveDate
now includes a niche. So nowOption<NaiveDate>
,Option<NaiveDateTime>
andOption<DateTime<Tz>>
are the same size as their base types. -
format::Numeric
andformat::Fixed
are marked asnon_exhaustive
. This will allow us to improve our formatting and parsing support, and we have reason to believe this breaking change will have little to no impact on users.
Additions
Deprecations
- Deprecate timestamp methods on
NaiveDateTime
(#1473) - Deprecate panicking constructors of
TimeDelta
(#1450)
Changes/fixes
- Use
NonZeroI32
insideNaiveDate
(#1207) - Mark
format::Numeric
andformat::Fixed
asnon_exhaustive
(#1430) Parsed
fixes to error values (#1439)- Use
overflowing_naive_local
inDateTime::checked_add*
(#1333) - Do complete range checks in
Parsed::set_*
(#1465)
Documentation
- Rustfmt doctests (#1452)
- Improve docs for crate features (#1455, thanks @edmorley)
- Add more documentation and examples to
Parsed
(#1439)
Internal
- Refactor
internals
module (#1428, #1429, #1431, #1432, #1433, #1438) - CI: test cross-compiling to
x86_64-unknown-illumos
instead of Solaris (#1437) - CI: lint Windows target, fix clippy warning (#1441)
- CI: only run
cargo hack check
on Linux (#1442) - Update windows-bindgen to 0.54 (#1462, #1483)
- Simplify error value of
parse_internal
(#1459) - Simplify
SerdeError
(#1458) - Simplify
NaiveDate::from_isoywd
a bit (#1464)
Thanks to all contributors on behalf of the chrono team, @djc and @pitdicker!
v0.4.34
Notable changes
- In chrono 0.4.34 we finished the work to make all methods const where doing so is supported by rust 1.61.
- We renamed the
Duration
type toTimeDelta
. This removes the confusion between chrono's type and the laterDuration
type in the standard library. It will remain available under the old name as a type alias for compatibility. - The Windows implementation of
Local
is rewritten. The new version avoids panics when the date is outside of the range supported by windows (the years 1601 to 30828), and gives more accurate results during DST transitions. - The
Display
format ofTimeDelta
is modified to conform better to ISO 8601. Previously it converted all values greater than 24 hours to a value with days. This is not correct, as doing so changes the duration from an 'accurate' to a 'nominal' representation to use ISO 8601 terms.
Fixes
- Add missing range check in
TimeDelta::milliseconds
(#1385, thanks @danwilliams) - Remove check for
DurationExceedsTimestamp
inDurationRound
(#1403, thanks @joroKr21) - Fix localized formatting with
%X
(chronotope/pure-rust-locales#12, #1420) - Windows: base implementation on
GetTimeZoneInformationForYear
(#1017)
Additions
- Add
TimeDelta::try_milliseconds
(#1385, thanks @danwilliams) - Add
TimeDelta::new
(#1337) - Add
StrftimeItems::{parse, parse_to_owned}
and more documentation (#1184) - More standard traits and documentation for
format::Locale
(via chronotope/pure-rust-locales#8)
Changes
- Rename
Duration
toTimeDelta
, add type alias (#1406) - Make
TimeDelta
methods const (#1337) - Make remaining methods of
NaiveDate
,NaiveWeek
,NaiveTime
andNaiveDateTime
const where possible (#1337) - Make methods on
DateTime
const where possible (#1400) - Make
Display
format ofTimeDelta
conform better to ISO 8601 (#1328)
Documentation
- Fix the formatting of
timestamp_micros
's Example doc (#1338 via #1386, thanks @emikitas) - Specify branch for GitHub Actions badge and fix link (#1388)
- Don't mention some deprecated methods in docs (#1395)
- Remove stray documentation from main (#1397)
- Improved documentation of
TimeDelta
constructors (#1385, thanks @danwilliams)
Internal
- Switch branch names: 0.4.x releases are the
main
branch, work on 0.5 happens in the0.5.x
branch (#1390, #1402). - Don't use deprecated method in
impl Arbitrary for DateTime
and set up CI test (#1336) - Remove workaround for Rust < 1.61 (#1393)
- Bump
codecov/codecov-action
from 3 to 4 (#1404) - Remove partial support for handling
-0000
offset (#1411) - Move
TOO_LONG
error out ofparse_internal
(#1419)
Thanks to all contributors on behalf of the chrono team, @djc and @pitdicker!
v0.4.33
This release fixes the broken docrs.rs build of chrono 0.4.32.
What's Changed
- Make
rkyv
feature implysize_32
(#1383) - Fixed typo in
Duration::hours()
exception (#1384, thanks @danwilliams)
v0.4.32
In this release we shipped part of the effort to reduce the number of methods that could unexpectedly panic, notably for the DateTime
and Duration
types.
Chrono internally stores the value of a DateTime
in UTC, and transparently converts it to the local value as required. For example adding a second to a DateTime
needs to be done in UTC to get the correct result, but adding a day needs to be done in local time to be correct. What happens when the value is near the edge of the representable range, and the implicit conversions pushes it beyond the representable range? Many methods could panic on such inputs, including formatting the value for Debug
output.
In chrono 0.4.32 the range of NaiveDate
, NaiveDateTime
and DateTime
is made slightly smaller. This allows us to always do the implicit conversion, and in many cases return the expected result. Specifically the range is now from January 1, -262144 until December 31, 262143, one year less on both sides than before. We expect this may trip up tests if you hardcoded the MIN
and MAX
dates.
Duration
had a similar issue. The range of this type was pretty arbitrary picked to match the range of an i64
in milliseconds. Negating an i64::MIN
pushes a value out of range, and in the same way negating Duration::MIN
could push it out of our defined range and cause a panic. This turns out to be somewhat common and hidden behind many layers of abstraction. We adjusted the type to have a minimum value of -Duration::MAX
instead and prevent the panic case.
Other highlights:
Duration
gained new fallible initialization methods.- Better support for
rkyv
. - Most methods on
NaiveDateTime
are now const. - We had to bump our MSRV to 1.61 to keep building with our dependencies. This will also allow us to make more methods on
DateTime
const in a future release.
Complete list of changes:
Fixes
- Fix panic in
TimeZone::from_local_datetime
(#1071) - Fix out of range panics in
DateTime
getters and setters (#1317, #1329)
Additions
- Add
NaiveDateTime::checked_(add|sub)_offset
(#1313) - Add
DateTime::to_utc
(#1325) - Derive
Default
forDuration
(#1327) - Add
Duration::subsec_nanos
(#1327) - Add
try_*
builders toDuration
(#1327) - Implement
AddAssign
andSubAssign
forDuration
(#1327) - Make methods on
NaiveDateTime
const where possible (#1286) - Split
clock
feature intoclock
andnow
(#1343, thanks @mmastrac) - Add
From<NaiveDate>
forNaiveDateTime
(#1355, thanks @dcechano) - Add
NaiveDateTime::from_timestamp_nanos
(#1357, thanks @Ali-Mirghasemi) - Add
Months::num_months()
andnum_years()
(#1373, thanks @danwilliams) - Add
DateTime<Utc>::from_timestamp_millis
(#1374, thanks @xmakro)
Changes
- Fix panic in
Duration::MIN.abs()
(adjustDuration::MIN
by 1 millisecond) (#1334) - Bump MSRV to 1.61 (#1347)
- Update windows-targets requirement from 0.48 to 0.52 (#1360)
- Update windows-bindgen to 0.52 (#1379)
Deprecations
- Deprecate standalone
format
functions (#1306)
Documentation
- Improve doc comment and tests for timestamp_nanos_opt (#1299, thanks @mlegner)
- Switch to
doc_auto_cfg
(#1305, #1326) - Document panics in
Add
/Sub
impls and useexpect
(#1316) - Improve types listed in top-level documentation (#1274)
- Improve deprecation note of
TimeZone::datetime_from_str
(#1342, thanks @tmccombs) - Fix typos in
Datelike
impl forDateTime
(#1376, thanks @ElectrifyPro)
Rkyv support
- Export
Archived*
types inrkyv
module (#1304) - Duplicate derives on
Archived*
types (#1271, thanks @Awpteamoose) - Archive derive of PartialEq for rkyv (#959, thanks @mkatychev)
- Expose rkyv features as features for chrono users (#1368, thanks @gz)
Changes to unstable features
- Don't let
unstable-locales
imply thealloc
feature (#1307) - Remove
format::{format_localized, format_item_localized}
(#1311) - Inline
write_rfc2822_inner
, don't localize (#1322)
Internal
- Add benchmark for
DateTime::with_*
(#1309) - Fix
*_DAYS_FROM_YEAR_0
calculation (#1312) - Add
NaiveTime::overflowing_(add|sub)_offset
(#1310) - Rewrite
DateTime::overflowing_(add|sub)_offset
(#1069) - Tests calling date command
set env LC_ALL
(#1315, thanks @jtmoon79) - Update
deny.toml
(#1320) - Bump actions/setup-node from 3 to 4 (#1346)
- test.yml remove errant
with: node-version
(#1352, thanks @jtmoon79) - CI Linting: Fix missing sources checkout in
toml
job (#1371, thanks @gibbz00) - Silence clippy lint for test code with Rust 1.74.0 (#1362)
Thanks to all contributors on behalf of the chrono team, @djc and @pitdicker!
v0.4.31
Another maintenance release.
It was not a planned effort to improve our support for UNIX timestamps, yet most PRs seem related to this.
Deprecations
- Deprecate
timestamp_nanos
in favor of the non-panickingtimestamp_nanos_opt
(#1275)
Additions
- Add
DateTime::<Utc>::from_timestamp
(#1279, thanks @demurgos) - Add
TimeZone::timestamp_micros
(#1285, thanks @emikitas) - Add
DateTime<Tz>::timestamp_nanos_opt
andNaiveDateTime::timestamp_nanos_opt
(#1275) - Add
UNIX_EPOCH
constants (#1291)
Fixes
- Format day of month in RFC 2822 without padding (#1272)
- Don't allow strange leap seconds which are not on a minute boundary initialization methods (#1283)
This makes many methods a little more strict:NaiveTime::from_hms_milli
NaiveTime::from_hms_milli_opt
NaiveTime::from_hms_micro
NaiveTime::from_hms_micro_opt
NaiveTime::from_hms_nano
NaiveTime::from_hms_nano_opt
NaiveTime::from_num_seconds_from_midnight
NaiveTime::from_num_seconds_from_midnight_opt
NaiveDate::and_hms_milli
NaiveDate::and_hms_milli_opt
NaiveDate::and_hms_micro
NaiveDate::and_hms_micro_opt
NaiveDate::and_hms_nano
NaiveDate::and_hms_nano_opt
NaiveDateTime::from_timestamp
NaiveDateTime::from_timestamp_opt
TimeZone::timestamp
TimeZone::timestamp_opt
- Fix underflow in
NaiveDateTime::timestamp_nanos_opt
(#1294, thanks @crepererum)
Documentation
- Add more documentation about the RFC 2822 obsolete date format (#1267)
Internal
- Remove internal
__doctest
feature anddoc_comment
dependency (#1276) - CI: Bump
actions/checkout
from 3 to 4 (#1280) - Optimize
NaiveDate::add_days
for small values (#1214) - Upgrade
pure-rust-locales
to 0.7.0 (#1288, thanks @jeremija wo did good improvements onpure-rust-locales
)
Thanks to all contributors on behalf of the chrono team, @djc and @pitdicker!