view release on metacpan or  search on metacpan

lib/Data/Tubes/Plugin/Writer.pod  view on Meta::CPAN

=over

=item C<binmode>

value to set via C<CORE::binmode> to opened filehandles (not to provided
ones though). See L<Data::Tubes::Util::Output>;

=item C<filename>

see above. Defaults to standard output;

=item C<footer>

data to be inserted as footer when closing/releasing a file, eventually
passed to L<Data::Tubes::Util::Output>. This parameter is initially
passed to L<Data::Tubes::Util/read_file_maybe>, so it can either be a
string (as required by L<Data::Tubes::Util::Output>, or an array
reference that is expanded into a list passed to
L<Data::Tubes::Util/read_file> for reading the text;


=item C<header>

data to be inserted as header when opening/starting to use a file,
eventually passed to L<Data::Tubes::Util::Output>. This parameter is
initially passed to L<Data::Tubes::Util/read_file_maybe>, so it can
either be a string (as required by L<Data::Tubes::Util::Output>, or an
array reference that is expanded into a list passed to
L<Data::Tubes::Util/read_file> for reading the text;

=item C<input>

input field in the record. This is what will actually be printed.
Defaults to C<rendered>, in compliance with the output of tubes from
L<Data::Tubes::Plugin::Renderer>.

=item C<interlude>

data to be inserted between records printed out, eventually passed to
L<Data::Tubes::Util::Output>. This parameter is initially passed to
L<Data::Tubes::Util/read_file_maybe>, so it can either be a string (as
required by L<Data::Tubes::Util::Output>, or an array reference that is
expanded into a list passed to L<Data::Tubes::Util/read_file> for
reading the text;

=item C<name>

name of the tube, useful when debugging;

=item C<policy>

a policy object where you can set thresholds for limiting the
content/size of generated files. See L<Data::Tubes::Util::Output>.

=back

=head2 B<< write_to_files >>

Alias for L</to_files>.

=head1 BUGS AND LIMITATIONS

Report bugs either through RT or GitHub (patches welcome).

=head1 AUTHOR

Flavio Poletti <polettix@cpan.org>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2016 by Flavio Poletti <polettix@cpan.org>

This module is free software. You can redistribute it and/or modify it
under the terms of the Artistic License 2.0.

This program is distributed in the hope that it will be useful, but
without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.

=cut