The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Text::PDF::API::IOString - Emulate IO::File interface for PDFs

SYNOPSIS

same as IO::String

DESCRIPTION

The Text::PDF::API::IOString module provide the IO::File interface for PDFs. This object can be attached to a string, and will make it possible to use the normal file operations for reading or writing data, as well as seeking to various locations of the string. The main reason you might want to do this, is if you have some other library module that only provide an interface to file handles, and you want to keep all the stuff in memory.

The module provide an interface compatible with IO::File as distributed with IO-1.20, but the following methods are not available; new_from_fd, fdopen, format_write, format_page_number, format_lines_per_page, format_lines_left, format_name, format_top_name.

The following methods are specific for the class:

$io->string_ref

This method will return a reference to the string that is attached to the IO::String object. Most useful when you let the IO::String create an internal buffer to write into.

$io->close

This method WILL NOT destroy the object but rather does nothing, use $io->realclose to do that. The main reason for this function is that there may be modukes that try to close the io-stream after they finished writing to it, but you may want to do something with the data afterwards

$io->realclose

see $io->close

BUGS

The perl TIEHANDLE interface is still not complete. There are quite a few file operations that will not yet invoke any method on the tied object. See perltie for details.

SEE ALSO

IO::File, IO::String

COPYRIGHT

Copyright 1998-2000 Gisle Aas.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Modified by Alfred Reibenschuh for use within Text::PDF::API.