TEST2::EVENTFACET::INFO(3perl)

πŸ’– Test2::EventFacet::Info β€” the 3perl manual, bestie edition πŸ’–

okay so this is the manual page for Test2::EventFacet::Info, part of the Perl Programmers Reference Guide. it's a facet, it's for info, and it's lowkey one of the most useful little guys in the Test2 universe. let's get into it 🌸


✨ NAME ✨

Test2::EventFacet::Info β€” the facet for information a developer might actually care about πŸ’…


🌈 DESCRIPTION 🌈

so basically, this facet is a lil container for messages meant for humans. like, actual people with feelings and eyeballs. these messages are here to help you either understand a result, or figure out why something failed. it's giving "helpful friend who explains the error instead of just yelling it at you" energy 🫢


πŸŽ€ NOTES πŸŽ€

heads up bestie β€” this facet shows up in a list, not as a single item. so don't go looking for one (1) info object, because there are many, and they're all in a list together. that's just the way it is ✨


πŸ”₯ FIELDS πŸ”₯

$string_or_structure = $info->{details} and $string_or_structure = $info->details()

this is the human readable string, or a whole data structure if you're feeling fancy β€” the actual info you want to show off. renderers/formatters are free to display structures however they want, no rules. and yeah, this thing can contain a blessed object, no big deal πŸ’…

oh and β€” if the table attribute (peep below πŸ‘€) is set, a renderer may decide to show the table instead of the details. its choice, its vibe.

$structure = $info->{table} and $structure = $info->table()

if the info you're trying to convey fits in a table, you can stick the data here in a rawer form so it renders nicer. BUT β€” and this is important β€” the data must also live in the details attribute, for the renderers that can't do tables. inclusivity, periodt 🧚

the table structure, exactly as it is:

my %table = {
    header => [ 'column 1 header', 'column 2 header', ... ], # Optional

    rows => [
        ['row 1 column 1', 'row 1, column 2', ... ],
        ['row 2 column 1', 'row 2, column 2', ... ],
        ...
    ],

    # Allow the renderer to hide empty columns when true, Optional
    collapse => $BOOL,

    # List by name or number columns that should never be collapsed
    no_collapse => \@LIST,
}

$short_string = $info->{tag} and $short_string = $info->tag()

a short lil tag to categorize the info. usually 10 characters or less β€” that's the vibe. formatters are allowed to truncate anything longer, so keep it cute and keep it brief βœ‚οΈ

$bool = $info->{debug} and $bool = $info->debug()

set this to true if the message is critical, or if it explains a failure. this is the info that formatters should show even when they're in less-verbose modes. it matters, it's main character energy πŸ‘‘

when it's false, the info isn't considered critical and might not get rendered at all in less-verbose modes. so use it wisely 😭

$bool = $info->{important} and $bool = $info->important

this one is for non debug messages that are STILL important enough to show when a formatter is in quiet mode. a formatter should send these to STDOUT, not STDERR, and should show them even in non-verbose mode. it's the "technically not an emergency but you need to see this" of attributes 🫢

fr fr, notice that important and debug are different shelves in the same closet β€” don't mix them up πŸ’œ

🌟 SOURCE 🌟

the source code repo for Test2 lives at <https://github.com/Test-More/test-more/> β€” go snoop, it's fine, we love a good repo crawl πŸ¦‹


πŸ‘‘ MAINTAINERS πŸ‘‘

Chad Granum <exodist@cpan.org> β€” the captain of this ship 🫑


πŸ’ AUTHORS πŸ’

Chad Granum <exodist@cpan.org> β€” same legend, different heading πŸ’–


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 <https://dev.perl.org/licenses/>


and that's the whole page, bestie πŸŽ€ documented by perl v5.44.0, dated 2026-10-17 β€” now go forth and render some info, slay πŸ’…βœ¨πŸ¦‹

πŸ“¦ where this page comes from
  • arch rolling: perl 5.44.0-1 Β· Artistic-1.0-Perl AND GPL-1.0-or-later
  • πŸ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms