Catman...terator(3pm)

💖 Catmandu::ArrayIterator 💖

okay bestie, gather round — this is the manual page for Catmandu::ArrayIterator, straight outta the User Contributed Perl Documentation. She's a Perl module (that's the (3pm) energy) and she has one job, and she does it flawlessly. 🫶

---

✨ NAME ✨

Catmandu::ArrayIterator — literally just converts an arrayref into an Iterable object. That's the whole thing. No cap. 👑

---

🌸 SYNOPSIS 🌸

Here's the vibe in code, copy-paste it, don't @ me:

use Catmandu::ArrayIterator;

my $it = Catmandu::ArrayIterator->new([{n => 1}, {n => 2}, {n => 3}]);

$it->each( sub {
    my $item = $_[0];
    # Very complicated routine
  ...
});

$it->[0];
# => {n => 1}
$it->first;
# => {n => 1}
$it->map(sub { $_[0]->{n} + 1 })->to_array;
# => [2, 3, 4]
$it->count
# => 3

See how she just… works? 😭✨ The array goes in, the iterator comes out, and she's giving main character energy the entire time.

---

🎀 METHODS 🎀

🌈 new($arrayRef)

Create a brand new iterator object from $arrayRef. That's it. Hand her an arrayref, she hands you back a whole Iterable. Slay. 💅

🌈 to_array

Return all the items in the Iterator as an ARRAY ref. Everything she's holding, back in your hands, in array form. Iconic behaviour. 🍓

🌈 each(&callback)

For each item in the Iterator, execute the callback function with the item as the first argument. And she's generous — she returns the number of items in the Iterator. So you get your loop and a headcount. Two birds, one module. 🦋

🌈 count

Return the count of all the items in the Iterator. Just the number. The whole number. Nothing but the number. Lowkey the most satisfying method here. ⭐

🌈 first

Return the first item from the Iterator. Only the first one. She's not giving you the rest, bestie — that's what the other methods are for. 🙈

---

💜 SEE ALSO 💜

Go read these next, they're the friend group:

• Catmandu::Iterable
• Catmandu::Iterator

---

And that's the whole page, bestie — no notes, ate, periodt. 💖✨

This one's running on perl v5.40.1 and it was stamped 2026-01-24, so like… freshly dated, freshly cunty. 🎀 Take care of her, she's doing her best. 🫶