.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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 "YAML::PP::Writer::File 3pm"
.TH YAML::PP::Writer::File 3pm 2025-02-15 "perl v5.40.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
YAML::PP::Writer::File \- Write YAML output to file or file handle
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    my $writer = YAML::PP::Writer::File\->new(output => $file);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The YAML::PP::Emitter sends its output to the writer.
.PP
You can use your own writer. if you want to send the YAML output to
somewhere else. See t/44.writer.t for an example.
.SH METHODS
.IX Header "METHODS"
.IP new 4
.IX Item "new"
.Vb 2
\&    my $writer = YAML::PP::Writer::File\->new(output => $file);
\&    my $writer = YAML::PP::Writer::File\->new(output => $filehandle);
.Ve
.Sp
Constructor.
.IP write 4
.IX Item "write"
.Vb 1
\&    $writer\->write(\*(Aq\- \*(Aq);
.Ve
.IP init 4
.IX Item "init"
.Vb 1
\&    $writer\->init;
.Ve
.Sp
Initialize
.IP finish 4
.IX Item "finish"
.Vb 1
\&    $writer\->finish;
.Ve
.Sp
Gets called when the output ends. If The argument was a filename, the
filehandle will be closed. If the argument was a filehandle, the caller needs to
close it.
.IP "output, set_output" 4
.IX Item "output, set_output"
Getter/setter for the YAML output