.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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 "FFI::C::PosixFile 3pm"
.TH FFI::C::PosixFile 3pm "2023-02-06" "perl v5.36.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"
FFI::C::PosixFile \- Perl interface to C File pointer with POSIX extensions
.SH "VERSION"
.IX Header "VERSION"
version 0.15
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use FFI::C::PosixFile;
\& 
\& my $stdout = FFI::C::PosixFile\->fdopen(1, "w");
\& say $stdout\->fileno;  # prints 1
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a subclass of FFI::C::File which adds a couple of useful \s-1POSIX\s0 extensions that
may not be available on non-POSIX systems.  Trying to create an instance of this class will
fail on platforms that do not support the extensions.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "fopen"
.IX Subsection "fopen"
.Vb 1
\& my $file = FFI::C::PosixFile\->fopen($filename, $mode);
.Ve
.PP
Opens the file with the given mode.  See your standard library C documentation for the
exact format of \f(CW$mode\fR.
.SS "new"
.IX Subsection "new"
.Vb 1
\& my $file = FFI::C::PosixFile\->new($ptr);
.Ve
.PP
Create a new File instance object from the opaque pointer.  Note that it isn't possible
to do any error checking on the type, so make sure that the pointer you are providing
really is a C file pointer.
.SS "fdopen"
.IX Subsection "fdopen"
.Vb 1
\& my $file = FFI::C::PosixFile\->fdopen($fd, $mode);
.Ve
.PP
Create a new File instance from a \s-1POSIX\s0 file descriptor.
.SH "METHODS"
.IX Header "METHODS"
.SS "fileno"
.IX Subsection "fileno"
.Vb 1
\& my $fd = $file\->fileno;
.Ve
.PP
Returns the \s-1POSIX\s0 file descriptor for the file pointer.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\s-1FFI::C\s0" 4
.IX Item "FFI::C"
.PD 0
.IP "FFI::C::Array" 4
.IX Item "FFI::C::Array"
.IP "FFI::C::ArrayDef" 4
.IX Item "FFI::C::ArrayDef"
.IP "FFI::C::Def" 4
.IX Item "FFI::C::Def"
.IP "FFI::C::File" 4
.IX Item "FFI::C::File"
.IP "FFI::C::PosixFile" 4
.IX Item "FFI::C::PosixFile"
.IP "FFI::C::Struct" 4
.IX Item "FFI::C::Struct"
.IP "FFI::C::StructDef" 4
.IX Item "FFI::C::StructDef"
.IP "FFI::C::Union" 4
.IX Item "FFI::C::Union"
.IP "FFI::C::UnionDef" 4
.IX Item "FFI::C::UnionDef"
.IP "FFI::C::Util" 4
.IX Item "FFI::C::Util"
.IP "FFI::Platypus::Record" 4
.IX Item "FFI::Platypus::Record"
.PD
.SH "AUTHOR"
.IX Header "AUTHOR"
Graham Ollis <plicease@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2020\-2022 by Graham Ollis.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.