Test::...Report(3pm)

💖 Test::Valgrind::Report — bestie edition 💖

ok so this is the Test::Valgrind::Report page, straight out of the Perl docs (manual name: Test::...Report(3pm), iykyk). it's a base class, it's giving foundation energy, and we're gonna walk through it together 🫶

✨ VERSION ✨

Version 1.19 — that's the one we're working with, no cap.

---

🌸 DESCRIPTION 🌸

okay so picture this: this class is the generic API for messages — the docs call them reports — and those reports get generated by the parser, filtered by the tool and the command, and then handled by the action. that's the whole pipeline bestie 💅

and here's the important part: the tool has authority for deciding which subclass of this one the reports should get blessed into. like, the tool is the one holding the aux cord here. periodt.

reports are also classified by kinds. and the Diag kind? that one is reserved for diagnostics. special little reserved seat, main character energy, nobody else sits there 🎀

---

💜 "new"

my $tvr = Test::Valgrind::Report->new(
 kind => $kind,
 id   => $id,
 data => $data,
);

your usual constructor, nothing chaotic here. but listen — all options are mandatory. all of them. no skipping:

• "kind" is the category of the report.
• "id" is an unique identifier for the report.
• "data" is the content.

---

🦋 "new_diag"

my $diag_report = Test::Valgrind::Report->new_diag($data);

constructs a report with kind 'Diag', an auto-incremented identifier, and the $data you handed it. so it just… handles the boring parts for you. iconic behavior honestly ✨

---

🎀 "kind"

my $kind = $tvr->kind;

read-only accessor for the "kind" option. look, don't touch 👑

---

💖 "id"

my $id = $tvr->id;

read-only accessor for the "id" option. same vibe, still read-only.

---

🌈 "data"

my $data = $tvr->data;

read-only accessor for the "data" option. you see the pattern by now bestie.

---

💀 "is_diag"

$tvr->is_diag;

tells you if a report has the 'Diag' kind — i.e. whether it's a diagnostic. vibe check for reports, essentially.

---

🧚 "kinds"

my @kinds = $tvr->kinds;

returns the list of valid kinds for this report class. and what does it default to? 'Diag'. that's it, that's the whole list for this base class.

---

⭐ "valid_kind"

$tvr->valid_kind($kind);

tells whether $kind is a valid kind for this report class. defaults to true iff "$kind eq 'Diag'". like, exactly that condition, no extra credit.

---

👑 SEE ALSO 👑

Test::Valgrind.

---

🫶 AUTHOR 🫶

Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.

you can contact him by mail or on "irc.perl.org" (vincent).

---

😭 BUGS 😭

please report any bugs or feature requests to "bug-test-valgrind at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>. he will be notified, and then you'll automatically be notified of progress on your bug as he makes changes. closed loop communication, we love to see it 💅

---

🍓 SUPPORT 🍓

you can find documentation for this module with the perldoc command.

perldoc Test::Valgrind::Report

---

💅 COPYRIGHT & LICENSE 💅

Copyright 2009,2010,2011,2013,2015,2016 Vincent Pit, all rights reserved.

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 was perl v5.40.1, dated 2025-04-13, and yes that's the real footer, i'm just telling you instead of copy-pasting it at you like a robot. slay 💖