Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Test2::EventFacet::Render (3)

Name

Test2::EventFacet::Render - Facet that dictates how to render an event.

Synopsis

Please see following description for synopsis

Description

Perl Programmers Reference Guide
                                                  Test2::EventFacet::Render(3)



NAME
       Test2::EventFacet::Render - Facet that dictates how to render an event.

DESCRIPTION
       This facet is used to dictate how the event should be rendered by the
       standard test2 rendering tools. If this facet is present then ONLY what
       is specified by it will be rendered. It is assumed that anything
       important or note-worthy will be present here, no other facets will be
       considered for rendering/display.

       This facet is a list type, you can add as many items as needed.

FIELDS
       $string = $render->[#]->{details}
       $string = $render->[#]->details()
           Human readable text for display.

       $string = $render->[#]->{tag}
       $string = $render->[#]->tag()
           Tag that should prefix/identify the main text.

       $string = $render->[#]->{facet}
       $string = $render->[#]->facet()
           Optional, if the display text was generated from another facet this
           should state what facet it was.

       $mode = $render->[#]->{mode}
       $mode = $render->[#]->mode()
           calculated
               Calculated means the facet was generated from another facet.
               Calculated facets may be cleared and regenerated whenever the
               event state changes.

           replace
               Replace means the facet is intended to replace the normal
               rendering of the event.

SOURCE
       The source code repository for Test2 can be found at
       http://github.com/Test-More/test-more/.

MAINTAINERS
       Chad Granum <exodist@cpan.org>

AUTHORS
       Chad Granum <exodist@cpan.org>

COPYRIGHT
       Copyright 2019 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 http://dev.perl.org/licenses/



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14
                                                  Test2::EventFacet::Render(3)