.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Mango::GridFS::Reader 3pm"
.TH Mango::GridFS::Reader 3pm "2020-06-05" "perl v5.30.3" "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"
Mango::GridFS::Reader \- GridFS reader
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Mango::GridFS::Reader;
\&
\&  my $reader = Mango::GridFS::Reader\->new(gridfs => $gridfs);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mango::GridFS::Reader reads files from GridFS.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
Mango::GridFS::Reader implements the following attributes.
.SS "gridfs"
.IX Subsection "gridfs"
.Vb 2
\&  my $gridfs = $reader\->gridfs;
\&  $reader    = $reader\->gridfs(Mango::GridFS\->new);
.Ve
.PP
Mango::GridFS object this reader belongs to.
.SH "METHODS"
.IX Header "METHODS"
Mango::GridFS::Reader inherits all methods from Mojo::Base and
implements the following new ones.
.SS "chunk_size"
.IX Subsection "chunk_size"
.Vb 1
\&  my $size = $reader\->chunk_size;
.Ve
.PP
Chunk size in bytes.
.SS "content_type"
.IX Subsection "content_type"
.Vb 1
\&  my $type = $reader\->content_type;
.Ve
.PP
Content type of file.
.SS "filename"
.IX Subsection "filename"
.Vb 1
\&  my $name = $reader\->filename;
.Ve
.PP
Name of file.
.SS "md5"
.IX Subsection "md5"
.Vb 1
\&  my $checksum = $reader\->md5;
.Ve
.PP
\&\s-1MD5\s0 checksum for file.
.SS "metadata"
.IX Subsection "metadata"
.Vb 1
\&  my $data = $reader\->metadata;
.Ve
.PP
Additional information.
.SS "open"
.IX Subsection "open"
.Vb 1
\&  $reader = $reader\->open($oid);
.Ve
.PP
Open file. You can also append a callback to perform operation non-blocking.
.PP
.Vb 5
\&  $reader\->open($oid => sub {
\&    my ($reader, $err) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "read"
.IX Subsection "read"
.Vb 1
\&  my $chunk = $reader\->read;
.Ve
.PP
Read chunk. You can also append a callback to perform operation non-blocking.
.PP
.Vb 5
\&  $reader\->read(sub {
\&    my ($reader, $err, $chunk) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "seek"
.IX Subsection "seek"
.Vb 1
\&  $reader = $reader\->seek(13);
.Ve
.PP
Change current position.
.SS "size"
.IX Subsection "size"
.Vb 1
\&  my $size = $reader\->size;
.Ve
.PP
Size of entire file in bytes.
.SS "slurp"
.IX Subsection "slurp"
.Vb 1
\&  my $data = $reader\->slurp;
.Ve
.PP
Slurp all remaining data from file. You can also append a callback to perform
operation non-blocking.
.PP
.Vb 5
\&  $reader\->slurp(sub {
\&    my ($reader, $err, $data) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "tell"
.IX Subsection "tell"
.Vb 1
\&  my $pos = $reader\->tell;
.Ve
.PP
Current position.
.SS "upload_date"
.IX Subsection "upload_date"
.Vb 1
\&  my $time = $reader\->upload_date;
.Ve
.PP
Date file was uploaded.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mango, Mojolicious::Guides, <http://mojolicio.us>.