.\" -*- 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 "Geo::GDAL::FFI::VSI::File 3pm"
.TH Geo::GDAL::FFI::VSI::File 3pm 2024-05-24 "perl v5.38.2" "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
Geo::GDAL::FFI::VSI::File \- A GDAL virtual file
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.SH METHODS
.IX Header "METHODS"
.SS Open
.IX Subsection "Open"
.Vb 1
\& my $vsifile = Geo::GDAL::FFI::VSI::File\->Open($name, $access);
.Ve
.PP
Open a virtual file. \f(CW$name\fR is the name of the file to open. \f(CW$access\fR is
\&'r', 'r+', 'a', or 'w'. 'r' is the default.
.PP
Returns a Geo::GDAL::FFI::VSI::File object.
.SS Close
.IX Subsection "Close"
Closes the file handle. Is done automatically when the object is
destroyed.
.SS Read($len)
.IX Subsection "Read($len)"
Read \f(CW$len\fR bytes from the file. Returns the bytes in a Perl
string. \f(CW$len\fR is optional and by default 1.
.SS Write($buf)
.IX Subsection "Write($buf)"
Write the Perl string \f(CW$buf\fR into the file. Returns the number of
successfully written bytes.
.SH LICENSE
.IX Header "LICENSE"
This software is released under the Artistic License. See
perlartistic.
.SH AUTHOR
.IX Header "AUTHOR"
Ari Jolma \- Ari.Jolma at gmail.com
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Geo::GDAL::FFI
.PP
Alien::gdal, FFI::Platypus, <http://www.gdal.org>