Attean...terator(3pm)

🦋 Attean::API::RepeatableIterator — the manual page, but make it make sense

okay so first things first: this is the Attean::API::RepeatableIterator page from the User Contributed Perl Documentation section of the manual (section 3pm, iykyk), and it's literally about a role for iterators that you can reset and iterate again. yes bestie, rewind-able iterators. main character energy fr fr 💅

---

✨ NAME ✨

Attean::API::RepeatableIterator — a role representing iterators that may be reset and iterated again 🎀

🌸 VERSION 🌸

This document describes Attean::API::RepeatableIterator version 0.035. periodt.

⭐ SYNOPSIS ⭐

  use v5.14;
  use Attean;

that's it. that's the synopsis. short and iconic, no notes 🫶

💜 DESCRIPTION 💜

So this is a Moo role, right? And it's consumed by iterators that can be reset and then iterated again. That's the whole vibe check: if your iterator can go back to the start, it wears this role like a little crown 👑.

🧚 ROLES 🧚

This role consumes the Attean::API::Iterator role. it's giving "borrowing your bestie's jacket" — it inherits the whole vibe 🌈

🔥 REQUIRED METHODS 🔥

If you're a class consuming this role, you must bring these to the group chat. no exceptions, ngl:

• reset — resets the state of the iterator, so you can iterate again from the start of the underlying data. it's the rewind button, the "actually let's rewatch from episode one" of methods 😭🔄

💖 METHODS 💖

This role hands you default implementations of these, already done, no cap:

• elements — returns a list of all the elements in the iterator, and leaves the iterator state untouched. so you can peek at the whole list without wrecking the current position ✨ lowkey the nicest thing a method can do for you.
• peek — returns the first element of the iterator, also leaving the iterator state untouched. it's giving "just looking, not touching" 🙈💅

Heads up: the sacred rule for both of these is that the iterator state stays exactly where it was. untouched. do not disturb the iterator, she's resting 💀

💀 BUGS 💀

Please report any bugs or feature requests through the GitHub web interface at https://github.com/kasei/attean/issues.

like, please actually tell them — silent bugs are not cute, bestie 😭

🦋 SEE ALSO 🦋

okay so this section is genuinely empty in the original. nothing here. crickets. she said nothing and left 🧚 i'm not hiding anything from you, that's just how the page is.

🍓 AUTHOR 🍓

Gregory Todd Williams <gwilliams@cpan.org> — the icon who made this 🫶

🌸 COPYRIGHT 🌸

Copyright (c) 2014--2022 Gregory Todd Williams. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

and that's the whole page, bestie! 💖 this gem was documented for perl v5.40.0 and dated 2025-01-26 — shoutout to the Attean...terator(3pm) footer energy, slay 🎀✨