Skip to content

span: allow ambiguous_negative_literals #51

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
BurntSushi merged 1 commit into from
Jul 27, 2024
Merged

span: allow ambiguous_negative_literals #51

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
24 changes: 24 additions & 0 deletions src/civil/date.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1367,6 +1367,8 @@ impl Date {
/// # Example: negative spans are supported
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
Copy link

@Urgau Urgau Jul 28, 2024

Choose a reason for hiding this comment

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

All of those manual allow-attr can be replaced with a single #![doc(test(attr(...)))] attr: #![doc(test(attr(allow(unknown_lints, ambiguous_negative_literals))))]

Copy link
Owner Author

@BurntSushi BurntSushi Jul 28, 2024

Choose a reason for hiding this comment

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

Oh wow, that's great to know! Thank you.

/// use jiff::{civil::Date, ToSpan};
///
/// let d = Date::constant(2024, 3, 31);
Expand All @@ -1380,6 +1382,8 @@ impl Date {
/// # Example: error on overflow
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Date, ToSpan};
///
/// let d = Date::constant(2024, 3, 31);
Expand Down Expand Up @@ -1471,6 +1475,8 @@ impl Date {
/// # Example: negative spans are supported
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Date, ToSpan};
///
/// let d = Date::constant(2024, 3, 31);
Expand All @@ -1484,6 +1490,8 @@ impl Date {
/// # Example: error on overflow
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Date, ToSpan};
///
/// let d = Date::constant(2024, 3, 31);
Expand Down Expand Up @@ -1535,6 +1543,8 @@ impl Date {
/// # Example: negative spans are supported
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Date, ToSpan};
///
/// let d = Date::constant(2024, 3, 31);
Expand All @@ -1547,6 +1557,8 @@ impl Date {
/// # Example: saturation on overflow
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Date, ToSpan};
///
/// let d = Date::constant(2024, 3, 31);
Expand Down Expand Up @@ -1604,6 +1616,8 @@ impl Date {
/// # Example: negative spans are supported
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Date, ToSpan};
///
/// let d = Date::constant(2024, 3, 31);
Expand All @@ -1616,6 +1630,8 @@ impl Date {
/// # Example: saturation on overflow
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Date, ToSpan};
///
/// let d = Date::constant(2024, 3, 31);
Expand Down Expand Up @@ -1669,6 +1685,8 @@ impl Date {
/// # Examples
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Date, ToSpan};
///
/// let earlier = Date::constant(2006, 8, 24);
Expand Down Expand Up @@ -1839,6 +1857,8 @@ impl Date {
/// # Examples
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Date, ToSpan};
///
/// let earlier = Date::constant(2006, 8, 24);
Expand Down Expand Up @@ -2035,6 +2055,8 @@ impl Date {
/// When did the most recent Friday the 13th occur?
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::{Date, Weekday}, ToSpan};
///
/// let start = Date::constant(2024, 3, 13);
Expand Down Expand Up @@ -2689,6 +2711,8 @@ impl DateDifference {
/// This shows how to always round "up" towards positive infinity.
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::{Date, DateDifference}, RoundMode, ToSpan, Unit};
///
/// let d1 = "2024-01-15".parse::<Date>()?;
Expand Down
20 changes: 20 additions & 0 deletions src/civil/datetime.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1482,6 +1482,8 @@ impl DateTime {
/// # Example: negative spans are supported
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::date, ToSpan};
///
/// let dt = date(2024, 3, 31).at(19, 5, 59, 999_999_999);
Expand All @@ -1496,6 +1498,8 @@ impl DateTime {
/// # Example: error on overflow
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::date, ToSpan};
///
/// let dt = date(2024, 3, 31).at(13, 13, 13, 13);
Expand Down Expand Up @@ -1581,6 +1585,8 @@ impl DateTime {
/// # Example: negative spans are supported
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::date, ToSpan};
///
/// let dt = date(2024, 3, 31).at(19, 5, 59, 999_999_999);
Expand All @@ -1595,6 +1601,8 @@ impl DateTime {
/// # Example: error on overflow
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::date, ToSpan};
///
/// let dt = date(2024, 3, 31).at(13, 13, 13, 13);
Expand Down Expand Up @@ -1642,6 +1650,8 @@ impl DateTime {
/// # Example: negative spans are supported
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::date, ToSpan};
///
/// let dt = date(2024, 3, 31).at(19, 5, 59, 999_999_999);
Expand All @@ -1654,6 +1664,8 @@ impl DateTime {
/// # Example: saturation on overflow
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::{DateTime, date}, ToSpan};
///
/// let dt = date(2024, 3, 31).at(13, 13, 13, 13);
Expand Down Expand Up @@ -1708,6 +1720,8 @@ impl DateTime {
/// # Example: negative spans are supported
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::date, ToSpan};
///
/// let dt = date(2024, 3, 31).at(19, 5, 59, 999_999_999);
Expand All @@ -1720,6 +1734,8 @@ impl DateTime {
/// # Example: saturation on overflow
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::{DateTime, date}, ToSpan};
///
/// let dt = date(2024, 3, 31).at(13, 13, 13, 13);
Expand Down Expand Up @@ -1780,6 +1796,8 @@ impl DateTime {
/// # Example
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::date, ToSpan};
///
/// let earlier = date(2006, 8, 24).at(22, 30, 0, 0);
Expand Down Expand Up @@ -1950,6 +1968,8 @@ impl DateTime {
/// # Example
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::date, ToSpan};
///
/// let earlier = date(2006, 8, 24).at(22, 30, 0, 0);
Expand Down
6 changes: 6 additions & 0 deletions src/civil/time.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1180,6 +1180,8 @@ impl Time {
/// # Examples
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Time, ToSpan};
///
/// let t1 = Time::constant(22, 35, 1, 0);
Expand Down Expand Up @@ -1267,6 +1269,8 @@ impl Time {
/// # Examples
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Time, ToSpan};
///
/// let t1 = Time::constant(22, 35, 1, 0);
Expand Down Expand Up @@ -1468,6 +1472,8 @@ impl Time {
/// Or go backwards every 6.5 hours:
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{civil::Time, ToSpan};
///
/// let start = Time::constant(23, 0, 0, 0);
Expand Down
2 changes: 2 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,8 @@ specifiers and other APIs.
#![warn(missing_debug_implementations)]
// Document ALL THE THINGS!
#![deny(missing_docs)]
// See: https://github.com/rust-lang/rust/pull/121364
#![allow(unknown_lints, ambiguous_negative_literals)]

// It should be possible to support other pointer widths, but this library
// hasn't been tested nor thought about much in contexts with pointers less
Expand Down
31 changes: 31 additions & 0 deletions src/span.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,16 @@ use crate::{
///
/// # Negative spans
///
/// **WARNING:** As of nightly Rust 2024-07-26, negating spans like
/// `-2.hours()` triggers a deny-by-default lint due to an ambiguous negative
/// literal. However, in Jiff's case, this is a false positive. Feel free to
/// `allow` the lint or write the span as `(-2).hours()` or `-(2.hours())`.
///
/// A span may be negative. All of these are equivalent:
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::{Span, ToSpan};
///
/// let span = -Span::new().days(5);
Expand Down Expand Up @@ -118,6 +125,8 @@ use crate::{
/// then all of its units are negative:
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::ToSpan;
///
/// let span = -5.days().hours(10).minutes(1);
Expand All @@ -130,6 +139,8 @@ use crate::{
/// as negative:
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::ToSpan;
///
/// // It's the same thing.
Expand Down Expand Up @@ -541,6 +552,8 @@ use crate::{
/// span positive before converting it to a `Duration`:
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use std::time::Duration;
///
/// use jiff::{Span, ToSpan};
Expand Down Expand Up @@ -990,6 +1003,8 @@ impl Span {
/// # Example
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::ToSpan;
///
/// let span = -100.seconds();
Expand Down Expand Up @@ -1055,6 +1070,8 @@ impl Span {
/// # Example
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::ToSpan;
///
/// assert!(!2.months().is_negative());
Expand All @@ -1072,6 +1089,8 @@ impl Span {
/// # Example
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::ToSpan;
///
/// assert!(!2.months().is_negative());
Expand Down Expand Up @@ -1108,6 +1127,8 @@ impl Span {
/// # Example
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::ToSpan;
///
/// let span = 4.days().seconds(8);
Expand All @@ -1129,6 +1150,8 @@ impl Span {
/// happens on overflow.
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::ToSpan;
///
/// let span = 4.days().seconds(8);
Expand Down Expand Up @@ -1493,6 +1516,8 @@ impl Span {
/// # Example: negative spans are less than zero
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::ToSpan;
///
/// let span1 = -1.second();
Expand Down Expand Up @@ -1893,6 +1918,8 @@ impl Span {
/// the span positive before converting it to a `Duration`:
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use std::time::Duration;
///
/// use jiff::{civil::date, Span, ToSpan};
Expand Down Expand Up @@ -2790,6 +2817,8 @@ impl core::ops::Mul<Span> for i64 {
/// span positive before converting it to a `Duration`:
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use std::time::Duration;
///
/// use jiff::{Span, ToSpan};
Expand Down Expand Up @@ -3039,6 +3068,8 @@ impl quickcheck::Arbitrary for Span {
/// # Example
///
/// ```
/// # // See: https://github.com/rust-lang/rust/pull/121364
/// # #![allow(unknown_lints, ambiguous_negative_literals)]
/// use jiff::ToSpan;
///
/// assert_eq!(5.days().to_string(), "P5d");
Expand Down
Loading