File Coverage

blib/lib/Data/Record/Serialize/Role/Sink.pm
Criterion Covered Total %
statement 8 8 100.0
branch n/a
condition n/a
subroutine 3 3 100.0
pod n/a
total 11 11 100.0


line stmt bran cond sub pod time code
1             package Data::Record::Serialize::Role::Sink;
2              
3             # ABSTRACT: Sink Role
4              
5 17     17   9182 use v5.12;
  17         75  
6 17     17   110 use Moo::Role;
  17         73  
  17         126  
7              
8 17     17   7296 use namespace::clean;
  17         59  
  17         169  
9              
10             our $VERSION = '1.05';
11              
12             requires 'print';
13             requires 'say';
14              
15              
16              
17              
18              
19              
20              
21              
22              
23              
24              
25              
26              
27              
28              
29             requires 'close';
30              
31             1;
32              
33             #
34             # This file is part of Data-Record-Serialize
35             #
36             # This software is Copyright (c) 2017 by Smithsonian Astrophysical Observatory.
37             #
38             # This is free software, licensed under:
39             #
40             # The GNU General Public License, Version 3, June 2007
41             #
42              
43             __END__
44              
45             =pod
46              
47             =for :stopwords Diab Jerius Smithsonian Astrophysical Observatory
48              
49             =head1 NAME
50              
51             Data::Record::Serialize::Role::Sink - Sink Role
52              
53             =head1 VERSION
54              
55             version 1.05
56              
57             =head1 DESCRIPTION
58              
59             If a role consumes this, it signals that it provides sink
60             capabilities.
61              
62             =head1 METHODS
63              
64             =head2 B<close>
65              
66             $s->close;
67              
68             Flush any data written to the sink and close it. While this will be
69             performed automatically when the object is destroyed, if the object is
70             not destroyed prior to global destruction at the end of the program,
71             it is quite possible that it will not be possible to perform this
72             cleanly. In other words, make sure that sinks are closed prior to
73             global destruction.
74              
75             =head1 INTERNALS
76              
77             =head1 SUPPORT
78              
79             =head2 Bugs
80              
81             Please report any bugs or feature requests to bug-data-record-serialize@rt.cpan.org or through the web interface at: L<https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Record-Serialize>
82              
83             =head2 Source
84              
85             Source is available at
86              
87             https://gitlab.com/djerius/data-record-serialize
88              
89             and may be cloned from
90              
91             https://gitlab.com/djerius/data-record-serialize.git
92              
93             =head1 SEE ALSO
94              
95             Please see those modules/websites for more information related to this module.
96              
97             =over 4
98              
99             =item *
100              
101             L<Data::Record::Serialize|Data::Record::Serialize>
102              
103             =back
104              
105             =head1 AUTHOR
106              
107             Diab Jerius <djerius@cpan.org>
108              
109             =head1 COPYRIGHT AND LICENSE
110              
111             This software is Copyright (c) 2017 by Smithsonian Astrophysical Observatory.
112              
113             This is free software, licensed under:
114              
115             The GNU General Public License, Version 3, June 2007
116              
117             =cut