cpan/Test-Simple/lib/Test2/EventFacet/About.pm

   1 package Test2::EventFacet::About;
   2 use strict;
   3 use warnings;
   4
   5 our $VERSION = '1.302198';
   6
   7 BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
   8 use Test2::Util::HashBase qw{ -package -no_display -uuid -eid };
   9
  10 1;
  11
  12 __END__
  13
  14 =pod
  15
  16 =encoding UTF-8
  17
  18 =head1 NAME
  19
  20 Test2::EventFacet::About - Facet with event details.
  21
  22 =head1 DESCRIPTION
  23
  24 This facet has information about the event, such as event package.
  25
  26 =head1 FIELDS
  27
  28 =over 4
  29
  30 =item $string = $about->{details}
  31
  32 =item $string = $about->details()
  33
  34 Summary about the event.
  35
  36 =item $package = $about->{package}
  37
  38 =item $package = $about->package()
  39
  40 Event package name.
  41
  42 =item $bool = $about->{no_display}
  43
  44 =item $bool = $about->no_display()
  45
  46 True if the event should be skipped by formatters.
  47
  48 =item $uuid = $about->{uuid}
  49
  50 =item $uuid = $about->uuid()
  51
  52 Will be set to a uuid if uuid tagging was enabled.
  53
  54 =item $uuid = $about->{eid}
  55
  56 =item $uuid = $about->eid()
  57
  58 A unique (for the test job) identifier for the event.
  59
  60 =back
  61
  62 =head1 SOURCE
  63
  64 The source code repository for Test2 can be found at
  65 F<http://github.com/Test-More/test-more/>.
  66
  67 =head1 MAINTAINERS
  68
  69 =over 4
  70
  71 =item Chad Granum E<lt>exodist@cpan.orgE<gt>
  72
  73 =back
  74
  75 =head1 AUTHORS
  76
  77 =over 4
  78
  79 =item Chad Granum E<lt>exodist@cpan.orgE<gt>
  80
  81 =back
  82
  83 =head1 COPYRIGHT
  84
  85 Copyright 2020 Chad Granum E<lt>exodist@cpan.orgE<gt>.
  86
  87 This program is free software; you can redistribute it and/or
  88 modify it under the same terms as Perl itself.
  89
  90 See F<http://dev.perl.org/licenses/>
  91
  92 =cut