TEST2::COMPARE::ARRAY(3perl)

📦
version 5.44.0 · 8 versions
, in arch rolling

💖 Test2::Compare::Array 💖

okay so bestie, welcome to Test2::Compare::Array — it's the internal representation of an array comparison for the Test2 suite. Like, this is not the module you reach for directly, it's the backstage crew making your array checks happen. ✨

🌸 NAME 🌸

Test2::Compare::Array — the internal representation of an array comparison. yep that's it, that's the name, slay 💅

🦋 DESCRIPTION 🦋

So this module is literally an internal representation of an array for comparison purposes. It's the little data structure that holds onto everything Test2 needs to know about how an array should look when it gets checked. Internal! Meaning it's doing its job behind the scenes while you live your main character life. 👑

✨ METHODS ✨

okay here's where it gets juicy, gather round 🫶

  • $ref = $arr->inref() — if this instance was built from an actual, real, flesh-and-blood array, this hands you back the reference to that array. no vibes, just the ref. 💖
  • $bool = $arr->ending — returns the current ending setting, and get this:
  • $arr->set_ending($bool) — set this one to true if you want it to fail when the array being validated has more items than the check does. Like, picture it: you check indexes 0-3 but the array has values for indexes 0-4? Boom, it fails and lists that last item as unexpected. 💀 If you set it to false, then the assumption is you simply do not care about extra items. live and let live, periodt.
  • $hashref = $arr->items() — returns the hashref of "key => val" pairs that are gonna be checked in the array. 🔑
  • $arr->set_items($hashref) — accepts a hashref, which lets you skip indexes if that's the mood you're in.
ngl, there's no validation when you use set_items, so it's genuinely better to go through the add_item interface instead. protect yourself bestie 🙈
  • $arrayref = $arr->order() — gives you back an arrayref of all the indexes that will be checked, in order. organized queen. 👑
  • $arr->set_order($arrayref) — sets the order in which indexes get checked.
same warning, fr fr: there's no validation when using set_order either. add_item is the safer route. 🎀
  • $name = $arr->name() — always, always returns the string "<ARRAY>". it never changes its mind, it's loyal like that. 💜
  • $bool = $arr->verify(got => $got, exists => $bool) — checks whether $got is an array reference or not. that's the whole gig. 🌈
  • $idx = $arr->top_index() — returns the topmost index that's being checked. it'll give you back undef if there are, like, no items at all, or 0 if there's only 1 item. yes bestie, 1 item means index zero. math is math. ✨
  • $arr->add_item($item) — pushes an item onto the list of values to be checked. simple, iconic. 🍓
  • $arr->add_item($idx => $item) — adds an item to the list of values to be checked at the specified index. now you're placing things precisely, we love precision. 💅
  • $arr->add_filter(sub { ... }) — adds a filter sub. here's how it works: the filter receives all remaining values of the array being checked, and it should return the values that should still be checked. and the timing? the filter runs between the last item added and the next item added. it's giving middle child energy and honestly? same. 😭
  • @deltas = $arr->deltas(got => $got, convert => \&convert, seen => \%seen) — finds all the differences between the expected array values and the ones sitting in the $got arrayref. this is the detective work. 🔍

🔥 SOURCE 🔥

The source code repository for Test2-Suite can be found at https://github.com/Test-More/test-more/. go star it or whatever, support the ecosystem bestie 🫶

👑 MAINTAINERS 👑

  • Chad Granum <exodist@cpan.org>

🌟 AUTHORS 🌟

  • Chad Granum <exodist@cpan.org>

Copyright Chad Granum <exodist@cpan.org>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://dev.perl.org/licenses/

and that's a wrap bestie 🎀 this whole vibe check came from perl v5.44.0, dated 2026-10-17, and it's the Test2::Compare::Array(3perl) page — no cap, every flag and every fact survived the glow-up, fr fr. bye queen 💖✨

📦 where this page comes from