.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Archive::Zip::MemberRead 3"
.TH Archive::Zip::MemberRead 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Archive::Zip::MemberRead \- A wrapper that lets you read Zip archive members as if they were files.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 8
\&  use Archive::Zip;
\&  use Archive::Zip::MemberRead;
\&  $zip = Archive::Zip\->new("file.zip");
\&  $fh  = Archive::Zip::MemberRead\->new($zip, "subdir/abc.txt");
\&  while (defined($line = $fh\->getline()))
\&  {
\&      print $fh\->input_line_number . "#: $line\en";
\&  }
\&
\&  $read = $fh\->read($buffer, 32*1024);
\&  print "Read $read bytes as :$buffer:\en";
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The Archive::Zip::MemberRead module lets you read Zip archive member data
just like you read data from files.
.SH METHODS
.IX Header "METHODS"
.IP \fBArchive::Zip::Member::readFileHandle()\fR 4
.IX Item "Archive::Zip::Member::readFileHandle()"
You can get a \f(CW\*(C`Archive::Zip::MemberRead\*(C'\fR from an archive member by
calling \f(CWreadFileHandle()\fR:
.Sp
.Vb 7
\&  my $member = $zip\->memberNamed(\*(Aqabc/def.c\*(Aq);
\&  my $fh = $member\->readFileHandle();
\&  while (defined($line = $fh\->getline()))
\&  {
\&      # ...
\&  }
\&  $fh\->close();
.Ve
.ie n .IP "Archive::Zip::MemberRead\->new($zip, $fileName)" 4
.el .IP "Archive::Zip::MemberRead\->new($zip, \f(CW$fileName\fR)" 4
.IX Item "Archive::Zip::MemberRead->new($zip, $fileName)"
.PD 0
.ie n .IP "Archive::Zip::MemberRead\->new($zip, $member)" 4
.el .IP "Archive::Zip::MemberRead\->new($zip, \f(CW$member\fR)" 4
.IX Item "Archive::Zip::MemberRead->new($zip, $member)"
.IP Archive::Zip::MemberRead\->new($member) 4
.IX Item "Archive::Zip::MemberRead->new($member)"
.PD
Construct a new Archive::Zip::MemberRead on the specified member.
.Sp
.Vb 1
\&  my $fh = Archive::Zip::MemberRead\->new($zip, \*(Aqfred.c\*(Aq)
.Ve
.IP setLineEnd(expr) 4
.IX Item "setLineEnd(expr)"
Set the line end character to use. This is set to \en by default
except on Windows systems where it is set to \er\en. You will
only need to set this on systems which are not Windows or Unix
based and require a line end different from \en.
This is a class method so call as \f(CW\*(C`Archive::Zip::MemberRead\*(C'\fR\->\f(CWsetLineEnd($nl)\fR
.IP \fBrewind()\fR 4
.IX Item "rewind()"
Rewinds an \f(CW\*(C`Archive::Zip::MemberRead\*(C'\fR so that you can read from it again
starting at the beginning.
.IP input_record_separator(expr) 4
.IX Item "input_record_separator(expr)"
If the argument is given, input_record_separator for this
instance is set to it. The current setting (which may be
the global $/) is always returned.
.IP \fBinput_line_number()\fR 4
.IX Item "input_line_number()"
Returns the current line number, but only if you're using \f(CWgetline()\fR.
Using \f(CWread()\fR will not update the line number.
.IP \fBclose()\fR 4
.IX Item "close()"
Closes the given file handle.
.ie n .IP "buffer_size([ $size ])" 4
.el .IP "buffer_size([ \f(CW$size\fR ])" 4
.IX Item "buffer_size([ $size ])"
Gets or sets the buffer size used for reads.
Default is the chunk size used by Archive::Zip.
.IP \fBgetline()\fR 4
.IX Item "getline()"
Returns the next line from the currently open member.
Makes sense only for text files.
A read error is considered fatal enough to die.
Returns undef on eof. All subsequent calls would return undef,
unless a \fBrewind()\fR is called.
Note: The line returned has the input_record_separator (default: newline) removed.
.IP "getline( { preserve_line_ending => 1 } )" 4
.IX Item "getline( { preserve_line_ending => 1 } )"
Returns the next line including the line ending.
.ie n .IP "read($buffer, $num_bytes_to_read)" 4
.el .IP "read($buffer, \f(CW$num_bytes_to_read\fR)" 4
.IX Item "read($buffer, $num_bytes_to_read)"
Simulates a normal \f(CWread()\fR system call.
Returns the no. of bytes read. \f(CW\*(C`undef\*(C'\fR on error, 0 on eof, \fIe.g.\fR:
.Sp
.Vb 9
\&  $fh = Archive::Zip::MemberRead\->new($zip, "sreeji/secrets.bin");
\&  while (1)
\&  {
\&    $read = $fh\->read($buffer, 1024);
\&    die "FATAL ERROR reading my secrets !\en" if (!defined($read));
\&    last if (!$read);
\&    # Do processing.
\&    ....
\&   }
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Sreeji K. Das <sreeji_k@yahoo.com>
.PP
See Archive::Zip by Ned Konz without which this module does not make
any sense!
.PP
Minor mods by Ned Konz.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2002 Sreeji K. Das.
.PP
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.