.\" 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::Writer 3pm" .TH Mango::GridFS::Writer 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::Writer \- GridFS writer .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Mango::GridFS::Writer; \& \& my $writer = Mango::GridFS::Writer\->new(gridfs => $gridfs); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Mango::GridFS::Writer writes files to GridFS. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" Mango::GridFS::Writer implements the following attributes. .SS "chunk_size" .IX Subsection "chunk_size" .Vb 2 \& my $size = $writer\->chunk_size; \& $writer = $writer\->chunk_size(1024); .Ve .PP Chunk size in bytes, defaults to \f(CW261120\fR (255KB). .SS "content_type" .IX Subsection "content_type" .Vb 2 \& my $type = $writer\->content_type; \& $writer = $writer\->content_type(\*(Aqtext/plain\*(Aq); .Ve .PP Content type of file. .SS "filename" .IX Subsection "filename" .Vb 2 \& my $name = $writer\->filename; \& $writer = $writer\->filename(\*(Aqfoo.txt\*(Aq); .Ve .PP Name of file. .SS "gridfs" .IX Subsection "gridfs" .Vb 2 \& my $gridfs = $writer\->gridfs; \& $writer = $writer\->gridfs(Mango::GridFS\->new); .Ve .PP Mango::GridFS object this writer belongs to. .SS "metadata" .IX Subsection "metadata" .Vb 2 \& my $data = $writer\->metadata; \& $writer = $writer\->metadata({foo => \*(Aqbar\*(Aq}); .Ve .PP Additional information. .SH "METHODS" .IX Header "METHODS" Mango::GridFS::Writer inherits all methods from Mojo::Base and implements the following new ones. .SS "close" .IX Subsection "close" .Vb 1 \& my $oid = $writer\->close; .Ve .PP Close file. You can also append a callback to perform operation non-blocking. .PP .Vb 5 \& $writer\->close(sub { \& my ($writer, $err, $oid) = @_; \& ... \& }); \& Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running; .Ve .SS "is_closed" .IX Subsection "is_closed" .Vb 1 \& my $success = $writer\->is_closed; .Ve .PP Check if file has been closed. .SS "write" .IX Subsection "write" .Vb 1 \& $writer = $writer\->write(\*(Aqhello world!\*(Aq); .Ve .PP Write chunk. You can also append a callback to perform operation non-blocking. .PP .Vb 5 \& $writer\->write(\*(Aqhello world!\*(Aq => sub { \& my ($writer, $err) = @_; \& ... \& }); \& Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running; .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" Mango, Mojolicious::Guides, .