Test2::...e::Array(3)

📦 version 1.302214, in opensuse-leap 16.0

okay so bestie 💖, you opened the Test2::...e::Array(3) page from the User Contributed Perl Documentation, and it's literally giving internal array-comparison lore. no cap, let's get into it 💅

🌸 NAME 🌸

Test2::Compare::Array — Internal representation of an array comparison.

🦋 DESCRIPTION 🦋

This module is an internal representation of an array for comparison purposes. That's the whole assignment — it's lowkey just holding the array-comparison vibe together 🫶

💅 METHODS 💅

  • $ref = $arr->inref() — if this instance was constructed from an actual array, this hands you back the reference to that array. slay ✨
  • $bool = $arr->ending / $arr->set_ending($bool) — set this to true if you would like it to fail when the array being validated has more items than the check. like, if you check indexes 0-3 but the array has values for indexes 0-4, it will fail and list that last item in the array as unexpected. If set to false, then it is assumed you do not care about extra items. iykyk 💅
  • $hashref = $arr->items() — returns the hashref of "key => val" pairs to be checked in the array. hashref realness 🎀
  • $arr->set_items($hashref) — accepts a hashref to permit indexes to be skipped if desired. Note: there is no validation when using set_items; it is better to use the add_item interface. heads up, bestie ⚠️
  • $arrayref = $arr->order() — returns an arrayref of all indexes that will be checked, in order. in order, periodt ✅
  • $arr->set_order($arrayref) — sets the order in which indexes will be checked. Note: there is no validation when using set_order; it is better to use the add_item interface. same warning energy ⚠️
  • $name = $arr->name() — always returns the string "<ARRAY>". always, no cap 🌈
  • $bool = $arr->verify(got => $got, exists => $bool) — check if $got is an array reference or not. literally the vibe check 💀
  • $idx = $arr->top_index() — returns the topmost index which is checked. This will return undef if there are no items, or 0 if there is only 1 item. math but make it cute 🔢
  • $arr->add_item($item) — push an item onto the list of values to be checked. add it, bestie 🍓
  • $arr->add_item($idx => $item) — add an item to the list of values to be checked at the specified index. indexed and iconic 👑
  • $arr->add_filter(sub { ... }) — add a filter sub. The filter receives all remaining values of the array being checked, and should return the values that should still be checked. The filter will be run between the last item added and the next item added. filter it out, but make it fashion 🧚
  • @deltas = $arr->deltas(got => $got, convert => \&convert, seen => \%seen) — find the differences between the expected array values and those in the $got arrayref. diff time 🔥

🔥 SOURCE 🔥

The source code repository for Test2-Suite can be found at https://github.com/Test-More/test-more/. go be nosy, 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/

xoxo bestie 💖 — this is from the User Contributed Perl Documentation, perl v5.42.0, dated 2025-07-28, and it's the Test2::...e::Array(3) page. periodt ✨

📦 where this page comes from