1package Test2::EventFacet::Render;
2use strict;
3use warnings;
4
5our $VERSION = '1.302175';
6
7sub is_list { 1 }
8
9BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
10use Test2::Util::HashBase qw{ -tag -facet -mode };
11
121;
13
14__END__
15
16=pod
17
18=encoding UTF-8
19
20=head1 NAME
21
22Test2::EventFacet::Render - Facet that dictates how to render an event.
23
24=head1 DESCRIPTION
25
26This facet is used to dictate how the event should be rendered by the standard
27test2 rendering tools. If this facet is present then ONLY what is specified by
28it will be rendered. It is assumed that anything important or note-worthy will
29be present here, no other facets will be considered for rendering/display.
30
31This facet is a list type, you can add as many items as needed.
32
33=head1 FIELDS
34
35=over 4
36
37=item $string = $render->[#]->{details}
38
39=item $string = $render->[#]->details()
40
41Human readable text for display.
42
43=item $string = $render->[#]->{tag}
44
45=item $string = $render->[#]->tag()
46
47Tag that should prefix/identify the main text.
48
49=item $string = $render->[#]->{facet}
50
51=item $string = $render->[#]->facet()
52
53Optional, if the display text was generated from another facet this should
54state what facet it was.
55
56=item $mode = $render->[#]->{mode}
57
58=item $mode = $render->[#]->mode()
59
60=over 4
61
62=item calculated
63
64Calculated means the facet was generated from another facet. Calculated facets
65may be cleared and regenerated whenever the event state changes.
66
67=item replace
68
69Replace means the facet is intended to replace the normal rendering of the
70event.
71
72=back
73
74=back
75
76=head1 SOURCE
77
78The source code repository for Test2 can be found at
79F<http://github.com/Test-More/test-more/>.
80
81=head1 MAINTAINERS
82
83=over 4
84
85=item Chad Granum E<lt>exodist@cpan.orgE<gt>
86
87=back
88
89=head1 AUTHORS
90
91=over 4
92
93=item Chad Granum E<lt>exodist@cpan.orgE<gt>
94
95=back
96
97=head1 COPYRIGHT
98
99Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
100
101This program is free software; you can redistribute it and/or
102modify it under the same terms as Perl itself.
103
104See F<http://dev.perl.org/licenses/>
105
106=cut
107