1Test::Valgrind::Report(U3s)er Contributed Perl DocumentatTieosnt::Valgrind::Report(3)
2
3
4

NAME

6       Test::Valgrind::Report - Base class for Test::Valgrind error reports.
7

VERSION

9       Version 1.19
10

DESCRIPTION

12       This class provides a generic API for messages (the so-called reports)
13       generated by the parser, filtered by the tool and the command, and
14       handled by the action.  The tool has authority for deciding in which
15       subclass of this one reports should be blessed.
16
17       Reports are classified by kinds.  The "Diag" kind is reserved for
18       diagnostics.
19
20   "new"
21          my $tvr = Test::Valgrind::Report->new(
22           kind => $kind,
23           id   => $id,
24           data => $data,
25          );
26
27       Your usual constructor.
28
29       All options are mandatory :
30
31       •   "kind" is the category of the report.
32
33       •   "id" is an unique identifier for the report.
34
35       •   "data" is the content.
36
37   "new_diag"
38           my $diag_report = Test::Valgrind::Report->new_diag($data);
39
40       Constructs a report with kind 'Diag', an auto-incremented identifier
41       and the given $data.
42
43   "kind"
44           my $kind = $tvr->kind;
45
46       Read-only accessor for the "kind" option.
47
48   "id"
49           my $id = $tvr->id;
50
51       Read-only accessor for the "id" option.
52
53   "data"
54           my $data = $tvr->data;
55
56       Read-only accessor for the "data" option.
57
58   "is_diag"
59           $tvr->is_diag;
60
61       Tells if a report has the 'Diag' kind, i.e. is a diagnostic.
62
63   "kinds"
64           my @kinds = $tvr->kinds;
65
66       Returns the list of valid kinds for this report class.
67
68       Defaults to 'Diag'.
69
70   "valid_kind"
71           $tvr->valid_kind($kind);
72
73       Tells whether $kind is a valid kind for this report class.
74
75       Defaults to true iff "$kind eq 'Diag'".
76

SEE ALSO

78       Test::Valgrind.
79

AUTHOR

81       Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
82
83       You can contact me by mail or on "irc.perl.org" (vincent).
84

BUGS

86       Please report any bugs or feature requests to "bug-test-valgrind at
87       rt.cpan.org", or through the web interface at
88       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>.  I will
89       be notified, and then you'll automatically be notified of progress on
90       your bug as I make changes.
91

SUPPORT

93       You can find documentation for this module with the perldoc command.
94
95           perldoc Test::Valgrind::Report
96

98       Copyright 2009,2010,2011,2013,2015,2016 Vincent Pit, all rights
99       reserved.
100
101       This program is free software; you can redistribute it and/or modify it
102       under the same terms as Perl itself.
103
104
105
106perl v5.36.0                      2023-01-20         Test::Valgrind::Report(3)
Impressum