Geo::GDAL  2.3
Geo::GDAL::VSIF Class Reference

A GDAL virtual file system.
More...

Public Member Functions

public method Close ()
 
public method MkDir (scalar path)
 
public Geo::GDAL::VSIF Open (scalar filename, scalar mode)
 
public scalar Read (scalar count)
 
public list ReadDir (scalar dir)
 
public scalar ReadDirRecursive (scalar dir)
 
public method Rename (scalar old, scalar new)
 
public method RmDir (scalar path)
 
public method Seek (scalar offset, scalar whence)
 
public list Stat (scalar filename)
 
public scalar Tell ()
 
public method Truncate (scalar new_size)
 
public method Unlink (scalar filename)
 
public method Write (scalar scalar)
 

Detailed Description

A GDAL virtual file system.



Definition at line 6749 of file all.dox.

Member Function Documentation

public method Geo::GDAL::VSIF::Close ( )

Object method.

Code:
click to view

public method Geo::GDAL::VSIF::MkDir ( scalar  path)

Package subroutine.
Make a directory.

Parameters
pathThe directory to make.
Note
The name of this method is VSIMkdir in GDAL.

Code:
click to view

public Geo::GDAL::VSIF Geo::GDAL::VSIF::Open ( scalar  filename,
scalar  mode 
)

Package subroutine.

Parameters
filenameName of the file to open. For example "/vsimem/x".
modeAccess mode. 'r', 'r+', 'w', etc.
Returns
A file handle on success.

Code:
click to view

public scalar Geo::GDAL::VSIF::Read ( scalar  count)

Object method.

Parameters
countThe number of bytes to read from the file.
Returns
A byte string.

Code:
click to view

public list Geo::GDAL::VSIF::ReadDir ( scalar  dir)

Package subroutine.

Returns
Contents of a directory in an anonymous array or as a list.

Code:
click to view

public scalar Geo::GDAL::VSIF::ReadDirRecursive ( scalar  dir)

Package subroutine.

Note
Give the directory in the form '/vsimem', i.e., without trailing '/'.
Returns
Contents of a directory tree in an anonymous array.

Code:
click to view

public method Geo::GDAL::VSIF::Rename ( scalar  old,
scalar  new 
)

Package subroutine.
Rename a file.

Note
The name of this method is VSIRename in GDAL.

Code:
click to view

public method Geo::GDAL::VSIF::RmDir ( scalar  path)

Package subroutine.
Remove a directory.

Note
The name of this method is VSIRmdir in GDAL.

Code:
click to view

public method Geo::GDAL::VSIF::Seek ( scalar  offset,
scalar  whence 
)

Object method.

Code:
click to view

public list Geo::GDAL::VSIF::Stat ( scalar  filename)

Package subroutine.

Returns
($filemode, $filesize). filemode is f for a plain file, d
for a directory, l for a symbolic link, p for a named pipe (FIFO), S
for a socket, b for a block special file, and c for a character
special file.

Code:
click to view

public scalar Geo::GDAL::VSIF::Tell ( )

Object method.

Code:
click to view

public method Geo::GDAL::VSIF::Truncate ( scalar  new_size)

Object method.

Code:
click to view

public method Geo::GDAL::VSIF::Unlink ( scalar  filename)

Package subroutine.

Parameters
filenameThe file to delete.
Returns
0 on success and -1 on an error.

public method Geo::GDAL::VSIF::Write ( scalar  scalar)

Object method.

Parameters
scalarThe byte string to write to the file.
Returns
Number of bytes written into the file.

Code:
click to view


The documentation for this class was generated from the following file: