Skip to content

Convert some iter macros to normal functions #124393

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.

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
merged 1 commit into from
Apr 26, 2024
Merged
Changes from all commits
Commits
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
41 changes: 20 additions & 21 deletions library/core/src/slice/iter/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,19 @@ macro_rules! iterator {
$into_ref:ident,
{$($extra:tt)*}
) => {
// Returns the first element and moves the start of the iterator forwards by 1.
// Greatly improves performance compared to an inlined function. The iterator
// must not be empty.
macro_rules! next_unchecked {
($self: ident) => { $self.post_inc_start(1).$into_ref() }
}

// Returns the last element and moves the end of the iterator backwards by 1.
// Greatly improves performance compared to an inlined function. The iterator
// must not be empty.
macro_rules! next_back_unchecked {
($self: ident) => { $self.pre_dec_end(1).$into_ref() }
}

impl<'a, T> $name<'a, T> {
/// Returns the last element and moves the end of the iterator backwards by 1.
///
/// # Safety
///
/// The iterator must not be empty
#[inline]
unsafe fn next_back_unchecked(&mut self) -> $elem {
// SAFETY: the caller promised it's not empty, so
// the offsetting is in-bounds and there's an element to return.
unsafe { self.pre_dec_end(1).$into_ref() }
}

// Helper function for creating a slice from the iterator.
#[inline(always)]
fn make_slice(&self) -> &'a [T] {
Expand Down Expand Up @@ -156,13 +154,13 @@ macro_rules! iterator {
fn next(&mut self) -> Option<$elem> {
// could be implemented with slices, but this avoids bounds checks

// SAFETY: The call to `next_unchecked!` is
// SAFETY: The call to `next_unchecked` is
// safe since we check if the iterator is empty first.
unsafe {
if is_empty!(self) {
None
} else {
Some(next_unchecked!(self))
Some(self.next_unchecked())
}
}
}
Expand Down Expand Up @@ -191,7 +189,7 @@ macro_rules! iterator {
// SAFETY: We are in bounds. `post_inc_start` does the right thing even for ZSTs.
unsafe {
self.post_inc_start(n);
Some(next_unchecked!(self))
Some(self.next_unchecked())
}
}

Expand Down Expand Up @@ -392,13 +390,13 @@ macro_rules! iterator {
fn next_back(&mut self) -> Option<$elem> {
// could be implemented with slices, but this avoids bounds checks

// SAFETY: The call to `next_back_unchecked!`
// SAFETY: The call to `next_back_unchecked`
// is safe since we check if the iterator is empty first.
unsafe {
if is_empty!(self) {
None
} else {
Some(next_back_unchecked!(self))
Some(self.next_back_unchecked())
}
}
}
Expand All @@ -416,7 +414,7 @@ macro_rules! iterator {
// SAFETY: We are in bounds. `pre_dec_end` does the right thing even for ZSTs.
unsafe {
self.pre_dec_end(n);
Some(next_back_unchecked!(self))
Some(self.next_back_unchecked())
}
}

Expand All @@ -436,10 +434,11 @@ macro_rules! iterator {
unsafe impl<T> TrustedLen for $name<'_, T> {}

impl<'a, T> UncheckedIterator for $name<'a, T> {
#[inline]
unsafe fn next_unchecked(&mut self) -> $elem {
// SAFETY: The caller promised there's at least one more item.
unsafe {
next_unchecked!(self)
self.post_inc_start(1).$into_ref()
}
}
}
Expand Down
Loading