/rust/registry/src/index.crates.io-6f17d22bba15001f/time-0.3.41/src/internal_macros.rs

Source (jump to first uncovered line)
//! Macros for use within the library. They are not publicly available.

/// Helper macro for easily implementing `OpAssign`.
macro_rules! __impl_assign {
    ($sym:tt $op:ident $fn:ident $target:ty : $($(#[$attr:meta])* $t:ty),+) => {$(
        #[allow(unused_qualifications)]
        $(#[$attr])*
        impl core::ops::$op<$t> for $target {
            fn $fn(&mut self, rhs: $t) {
                *self = *self $sym rhs;
            }
        }
    )+};
}

/// Implement `AddAssign` for the provided types.
macro_rules! impl_add_assign {
    ($target:ty : $($(#[$attr:meta])* $t:ty),+ $(,)?) => {
        $crate::internal_macros::__impl_assign!(
            + AddAssign add_assign $target : $($(#[$attr])* $t),+
        );
    };
}

/// Implement `SubAssign` for the provided types.
macro_rules! impl_sub_assign {
    ($target:ty : $($(#[$attr:meta])* $t:ty),+ $(,)?) => {
        $crate::internal_macros::__impl_assign!(
            - SubAssign sub_assign $target : $($(#[$attr])* $t),+
        );
    };
}

/// Implement `MulAssign` for the provided types.
macro_rules! impl_mul_assign {
    ($target:ty : $($(#[$attr:meta])* $t:ty),+ $(,)?) => {
        $crate::internal_macros::__impl_assign!(
            * MulAssign mul_assign $target : $($(#[$attr])* $t),+
        );
    };
}

/// Implement `DivAssign` for the provided types.
macro_rules! impl_div_assign {
    ($target:ty : $($(#[$attr:meta])* $t:ty),+ $(,)?) => {
        $crate::internal_macros::__impl_assign!(
            / DivAssign div_assign $target : $($(#[$attr])* $t),+
        );
    };
}

/// Division of integers, rounding the resulting value towards negative infinity.
macro_rules! div_floor {
    ($self:expr, $rhs:expr) => {
        match ($self, $rhs) {
            (this, rhs) => {
                let d = this / rhs;
                let r = this % rhs;

                // If the remainder is non-zero, we need to subtract one if the
                // signs of self and rhs differ, as this means we rounded upwards
                // instead of downwards. We do this branchlessly by creating a mask
                // which is all-ones iff the signs differ, and 0 otherwise. Then by
                // adding this mask (which corresponds to the signed value -1), we
                // get our correction.
                let correction = (this ^ rhs) >> ($crate::size_of_val(&this) * 8 - 1);
                if r != 0 {
                    d + correction
                } else {
                    d
                }
            }
        }
    };
}

/// Cascade an out-of-bounds value.
macro_rules! cascade {
    (@ordinal ordinal) => {};
    (@year year) => {};

    // Cascade an out-of-bounds value from "from" to "to".
    ($from:ident in $min:literal.. $max:expr => $to:tt) => {
        #[allow(unused_comparisons, unused_assignments)]
        let min = $min;
        let max = $max;
        if $from >= max {
            $from -= max - min;
            $to += 1;
        } else if $from < min {
            $from += max - min;
            $to -= 1;
        }
    };

    // Special case the ordinal-to-year cascade, as it has different behavior.
    ($ordinal:ident => $year:ident) => {
        // We need to actually capture the idents. Without this, macro hygiene causes errors.
        cascade!(@ordinal $ordinal);
        cascade!(@year $year);
        #[allow(unused_assignments)]
        if $ordinal > crate::util::days_in_year($year) as i16 {
            $ordinal -= crate::util::days_in_year($year) as i16;
            $year += 1;
        } else if $ordinal < 1 {
            $year -= 1;
            $ordinal += crate::util::days_in_year($year) as i16;
        }
    };
}

/// Constructs a ranged integer, returning a `ComponentRange` error if the value is out of range.
macro_rules! ensure_ranged {
    ($type:ident : $value:ident) => {
        match $type::new($value) {
            Some(val) => val,
            None => {
                #[allow(trivial_numeric_casts)]
                return Err(crate::error::ComponentRange {
                    name: stringify!($value),
                    minimum: $type::MIN.get() as i64,
                    maximum: $type::MAX.get() as i64,
                    value: $value as i64,
                    conditional_message: None,
                });
            }
        }
    };

    ($type:ident : $value:ident $(as $as_type:ident)? * $factor:expr) => {
        match ($value $(as $as_type)?).checked_mul($factor) {
            Some(val) => match $type::new(val) {
                Some(val) => val,
                None => {
                    #[allow(trivial_numeric_casts)]
                    return Err(crate::error::ComponentRange {
                        name: stringify!($value),
                        minimum: $type::MIN.get() as i64 / $factor as i64,
                        maximum: $type::MAX.get() as i64 / $factor as i64,
                        value: $value as i64,
                        conditional_message: None,
                    });
                }
            },
            None => {
                return Err(crate::error::ComponentRange {
                    name: stringify!($value),
                    minimum: $type::MIN.get() as i64 / $factor as i64,
                    maximum: $type::MAX.get() as i64 / $factor as i64,
                    value: $value as i64,
                    conditional_message: None,
                });
            }
        }
    };
}

/// Try to unwrap an expression, returning if not possible.
///
/// This is similar to the `?` operator, but does not perform `.into()`. Because of this, it is
/// usable in `const` contexts.
macro_rules! const_try {
    ($e:expr) => {
        match $e {
            Ok(value) => value,
            Err(error) => return Err(error),
        }
    };
}

/// Try to unwrap an expression, returning if not possible.
///
/// This is similar to the `?` operator, but is usable in `const` contexts.
macro_rules! const_try_opt {
    ($e:expr) => {
        match $e {
            Some(value) => value,
            None => return None,
        }
    };
}

/// Try to unwrap an expression, panicking if not possible.
///
/// This is similar to `$e.expect($message)`, but is usable in `const` contexts.
macro_rules! expect_opt {
    ($e:expr, $message:literal) => {
        match $e {
            Some(value) => value,
            None => crate::expect_failed($message),
        }
    };
}

/// `unreachable!()`, but better.
#[cfg(any(feature = "formatting", feature = "parsing"))]
macro_rules! bug {
    () => { compile_error!("provide an error message to help fix a possible bug") };
    ($descr:literal $($rest:tt)?) => {
        panic!(concat!("internal error: ", $descr) $($rest)?)
    }
}

#[cfg(any(feature = "formatting", feature = "parsing"))]
pub(crate) use bug;
pub(crate) use {
    __impl_assign, cascade, const_try, const_try_opt, div_floor, ensure_ranged, expect_opt,
    impl_add_assign, impl_div_assign, impl_mul_assign, impl_sub_assign,
};

Coverage Report

Created: 2025-07-11 07:02

Line	Count	Source (jump to first uncovered line)
1		//! Macros for use within the library. They are not publicly available.
2
3		/// Helper macro for easily implementing `OpAssign`.
4		macro_rules! __impl_assign {
5		($sym:tt $op:ident $fn:ident $target:ty : $($(#[$attr:meta])* $t:ty),+) => {$(
6		#[allow(unused_qualifications)]
7		$(#[$attr])*
8		impl core::ops::$op<$t> for $target {
9	0	fn $fn(&mut self, rhs: $t) {
10	0	self = self $sym rhs;
11	0	} Unexecuted instantiation: <time::time::Time as core::ops::arith::AddAssign<time::duration::Duration>>::add_assign Unexecuted instantiation: <time::time::Time as core::ops::arith::AddAssign<core::time::Duration>>::add_assign Unexecuted instantiation: <time::time::Time as core::ops::arith::SubAssign<time::duration::Duration>>::sub_assign Unexecuted instantiation: <time::time::Time as core::ops::arith::SubAssign<core::time::Duration>>::sub_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::AddAssign>::add_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::AddAssign<core::time::Duration>>::add_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::SubAssign>::sub_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::SubAssign<core::time::Duration>>::sub_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::MulAssign<i8>>::mul_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::MulAssign<i16>>::mul_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::MulAssign<i32>>::mul_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::MulAssign<u8>>::mul_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::MulAssign<u16>>::mul_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::MulAssign<u32>>::mul_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::MulAssign<f32>>::mul_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::MulAssign<f64>>::mul_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::DivAssign<i8>>::div_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::DivAssign<i16>>::div_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::DivAssign<i32>>::div_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::DivAssign<u8>>::div_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::DivAssign<u16>>::div_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::DivAssign<u32>>::div_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::DivAssign<f32>>::div_assign Unexecuted instantiation: <time::duration::Duration as core::ops::arith::DivAssign<f64>>::div_assign Unexecuted instantiation: <time::date::Date as core::ops::arith::AddAssign<time::duration::Duration>>::add_assign Unexecuted instantiation: <time::date::Date as core::ops::arith::AddAssign<core::time::Duration>>::add_assign Unexecuted instantiation: <time::date::Date as core::ops::arith::SubAssign<time::duration::Duration>>::sub_assign Unexecuted instantiation: <time::date::Date as core::ops::arith::SubAssign<core::time::Duration>>::sub_assign Unexecuted instantiation: <time::instant::Instant as core::ops::arith::AddAssign<time::duration::Duration>>::add_assign Unexecuted instantiation: <time::instant::Instant as core::ops::arith::AddAssign<core::time::Duration>>::add_assign Unexecuted instantiation: <time::instant::Instant as core::ops::arith::SubAssign<time::duration::Duration>>::sub_assign Unexecuted instantiation: <time::instant::Instant as core::ops::arith::SubAssign<core::time::Duration>>::sub_assign Unexecuted instantiation: <std::time::SystemTime as core::ops::arith::AddAssign<time::duration::Duration>>::add_assign Unexecuted instantiation: <std::time::SystemTime as core::ops::arith::SubAssign<time::duration::Duration>>::sub_assign Unexecuted instantiation: <std::time::Instant as core::ops::arith::AddAssign<time::duration::Duration>>::add_assign Unexecuted instantiation: <std::time::Instant as core::ops::arith::SubAssign<time::duration::Duration>>::sub_assign
12		}
13		)+};
14		}
15
16		/// Implement `AddAssign` for the provided types.
17		macro_rules! impl_add_assign {
18		($target:ty : $($(#[$attr:meta])* $t:ty),+ $(,)?) => {
19		$crate::internal_macros::__impl_assign!(
20		+ AddAssign add_assign $target : $($(#[$attr])* $t),+
21		);
22		};
23		}
24
25		/// Implement `SubAssign` for the provided types.
26		macro_rules! impl_sub_assign {
27		($target:ty : $($(#[$attr:meta])* $t:ty),+ $(,)?) => {
28		$crate::internal_macros::__impl_assign!(
29		- SubAssign sub_assign $target : $($(#[$attr])* $t),+
30		);
31		};
32		}
33
34		/// Implement `MulAssign` for the provided types.
35		macro_rules! impl_mul_assign {
36		($target:ty : $($(#[$attr:meta])* $t:ty),+ $(,)?) => {
37		$crate::internal_macros::__impl_assign!(
38		* MulAssign mul_assign $target : $($(#[$attr])* $t),+
39		);
40		};
41		}
42
43		/// Implement `DivAssign` for the provided types.
44		macro_rules! impl_div_assign {
45		($target:ty : $($(#[$attr:meta])* $t:ty),+ $(,)?) => {
46		$crate::internal_macros::__impl_assign!(
47		/ DivAssign div_assign $target : $($(#[$attr])* $t),+
48		);
49		};
50		}
51
52		/// Division of integers, rounding the resulting value towards negative infinity.
53		macro_rules! div_floor {
54		($self:expr, $rhs:expr) => {
55		match ($self, $rhs) {
56		(this, rhs) => {
57		let d = this / rhs;
58		let r = this % rhs;
59
60		// If the remainder is non-zero, we need to subtract one if the
61		// signs of self and rhs differ, as this means we rounded upwards
62		// instead of downwards. We do this branchlessly by creating a mask
63		// which is all-ones iff the signs differ, and 0 otherwise. Then by
64		// adding this mask (which corresponds to the signed value -1), we
65		// get our correction.
66		let correction = (this ^ rhs) >> ($crate::size_of_val(&this) * 8 - 1);
67		if r != 0 {
68		d + correction
69		} else {
70		d
71		}
72		}
73		}
74		};
75		}
76
77		/// Cascade an out-of-bounds value.
78		macro_rules! cascade {
79		(@ordinal ordinal) => {};
80		(@year year) => {};
81
82		// Cascade an out-of-bounds value from "from" to "to".
83		($from:ident in $min:literal.. $max:expr => $to:tt) => {
84		#[allow(unused_comparisons, unused_assignments)]
85		let min = $min;
86		let max = $max;
87		if $from >= max {
88		$from -= max - min;
89		$to += 1;
90		} else if $from < min {
91		$from += max - min;
92		$to -= 1;
93		}
94		};
95
96		// Special case the ordinal-to-year cascade, as it has different behavior.
97		($ordinal:ident => $year:ident) => {
98		// We need to actually capture the idents. Without this, macro hygiene causes errors.
99		cascade!(@ordinal $ordinal);
100		cascade!(@year $year);
101		#[allow(unused_assignments)]
102		if $ordinal > crate::util::days_in_year($year) as i16 {
103		$ordinal -= crate::util::days_in_year($year) as i16;
104		$year += 1;
105		} else if $ordinal < 1 {
106		$year -= 1;
107		$ordinal += crate::util::days_in_year($year) as i16;
108		}
109		};
110		}
111
112		/// Constructs a ranged integer, returning a `ComponentRange` error if the value is out of range.
113		macro_rules! ensure_ranged {
114		($type:ident : $value:ident) => {
115		match $type::new($value) {
116		Some(val) => val,
117		None => {
118		#[allow(trivial_numeric_casts)]
119		return Err(crate::error::ComponentRange {
120		name: stringify!($value),
121		minimum: $type::MIN.get() as i64,
122		maximum: $type::MAX.get() as i64,
123		value: $value as i64,
124		conditional_message: None,
125		});
126		}
127		}
128		};
129
130		($type:ident : $value:ident $(as $as_type:ident)? * $factor:expr) => {
131		match ($value $(as $as_type)?).checked_mul($factor) {
132		Some(val) => match $type::new(val) {
133		Some(val) => val,
134		None => {
135		#[allow(trivial_numeric_casts)]
136		return Err(crate::error::ComponentRange {
137		name: stringify!($value),
138		minimum: $type::MIN.get() as i64 / $factor as i64,
139		maximum: $type::MAX.get() as i64 / $factor as i64,
140		value: $value as i64,
141		conditional_message: None,
142		});
143		}
144		},
145		None => {
146		return Err(crate::error::ComponentRange {
147		name: stringify!($value),
148		minimum: $type::MIN.get() as i64 / $factor as i64,
149		maximum: $type::MAX.get() as i64 / $factor as i64,
150		value: $value as i64,
151		conditional_message: None,
152		});
153		}
154		}
155		};
156		}
157
158		/// Try to unwrap an expression, returning if not possible.
159		///
160		/// This is similar to the `?` operator, but does not perform `.into()`. Because of this, it is
161		/// usable in `const` contexts.
162		macro_rules! const_try {
163		($e:expr) => {
164		match $e {
165		Ok(value) => value,
166		Err(error) => return Err(error),
167		}
168		};
169		}
170
171		/// Try to unwrap an expression, returning if not possible.
172		///
173		/// This is similar to the `?` operator, but is usable in `const` contexts.
174		macro_rules! const_try_opt {
175		($e:expr) => {
176		match $e {
177		Some(value) => value,
178		None => return None,
179		}
180		};
181		}
182
183		/// Try to unwrap an expression, panicking if not possible.
184		///
185		/// This is similar to `$e.expect($message)`, but is usable in `const` contexts.
186		macro_rules! expect_opt {
187		($e:expr, $message:literal) => {
188		match $e {
189		Some(value) => value,
190		None => crate::expect_failed($message),
191		}
192		};
193		}
194
195		/// `unreachable!()`, but better.
196		#[cfg(any(feature = "formatting", feature = "parsing"))]
197		macro_rules! bug {
198		() => { compile_error!("provide an error message to help fix a possible bug") };
199		($descr:literal $($rest:tt)?) => {
200		panic!(concat!("internal error: ", $descr) $($rest)?)
201		}
202		}
203
204		#[cfg(any(feature = "formatting", feature = "parsing"))]
205		pub(crate) use bug;
206		pub(crate) use {
207		__impl_assign, cascade, const_try, const_try_opt, div_floor, ensure_ranged, expect_opt,
208		impl_add_assign, impl_div_assign, impl_mul_assign, impl_sub_assign,
209		};