Skip to content

make firstrest an alias for Iterators.peel #130

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

Open
nsajko wants to merge 4 commits into
base: master
Choose a base branch
from
Open

make firstrest an alias for Iterators.peel #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c659ff
simplify `firstrest` using `Iterators.peel`
nsajko Mar 4, 2026
158dcc6
deprecate `firstrest`
nsajko Mar 8, 2026
d96f4a1
just make it an alias
nsajko Mar 27, 2026
1c61fb9
update test
nsajko Mar 27, 2026
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
10 changes: 2 additions & 8 deletions src/IterTools.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ end

Return the first element and an iterator of the rest as a tuple.

See also: `Base.Iterators.peel`.
Alias for `Base.Iterators.peel`.

```jldoctest
julia> f, r = firstrest(1:3);
Expand All @@ -127,13 +127,7 @@ julia> collect(r)
3
```
"""
function firstrest(xs)
t = iterate(xs)
t === nothing && throw(ArgumentError("collection must be non-empty"))
f, s = t
r = Iterators.rest(xs, s)
return f, r
end
const firstrest = Iterators.peel

# Iterate through the first n elements, throwing an exception if
# fewer than n items ar encountered.
Expand Down
2 changes: 1 addition & 1 deletion test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ include("testing_macros.jl")
]

@testset "$xs" for (xs, s) in test_empty_cases
@test_throws ArgumentError firstrest(xs)
@test nothing === firstrest(xs)
end
end

Expand Down
Loading