public

Inheritance Graph

graph BT
	ZIPProvider
	ZIPProvider --> AbstractFSProvider
	click ZIPProvider "classUtil_1_1ZIPProvider"
	click AbstractFSProvider "classUtil_1_1AbstractFSProvider"

Description

File system provider for access to ZIP files using the “zip://path/to/archive$file_in_archive” URL scheme.

Author: Benjamin Eikel

Date: 2010-03-11

Classes

   
class Util::ZIPProvider::ZIPHandle

Public Static Functions

   
   
bool init()

Public Functions

   
   
  ZIPProvider()
   
  ~ZIPProvider()
   
status_t readFile(const FileName & url, std::vector< uint8_t > & data)
   
status_t writeFile(const FileName & url, const std::vector< uint8_t > & data, bool overwrite)
   
status_t dir(const FileName & url, std::list< FileName > & result, uint8_t flags)
   
bool isFile(const FileName & url)
   
bool isDir(const FileName & url)
   
size_t fileSize(const FileName & url)
   
status_t makeDir(const FileName & url)
   
status_t makeDirRecursive(const FileName & url)
   
status_t remove(const FileName & url)
   
void flush()

Documentation

function
Util::ZIPProvider::init

public static
   
   
bool init( )

Defined in Util/IO/ZIPProvider.h:35


function
Util::ZIPProvider::ZIPProvider

public
   
   
ZIPProvider( )

Defined in Util/IO/ZIPProvider.h:37


function
Util::ZIPProvider::~ZIPProvider

public virtual
   
   
~ZIPProvider( )

Defined in Util/IO/ZIPProvider.h:38


function
Util::ZIPProvider::readFile

public virtual
     
     
status_t readFile( const FileName & url,
  std::vector< uint8_t > & data
)    

Defined in Util/IO/ZIPProvider.h:40


function
Util::ZIPProvider::writeFile

public virtual
     
     
status_t writeFile( const FileName & url,
  const std::vector< uint8_t > & data,
  bool overwrite
)    

Defined in Util/IO/ZIPProvider.h:41


function
Util::ZIPProvider::dir

public virtual
     
     
status_t dir( const FileName & url,
  std::list< FileName > & result,
  uint8_t flags
)    

Defined in Util/IO/ZIPProvider.h:43


function
Util::ZIPProvider::isFile

public virtual
     
     
bool isFile( const FileName & url )

Defined in Util/IO/ZIPProvider.h:44


function
Util::ZIPProvider::isDir

public virtual
     
     
bool isDir( const FileName & url )

Defined in Util/IO/ZIPProvider.h:45


function
Util::ZIPProvider::fileSize

public virtual
     
     
size_t fileSize( const FileName & url )

Defined in Util/IO/ZIPProvider.h:46


function
Util::ZIPProvider::makeDir

public virtual
     
     
status_t makeDir( const FileName & url )

Defined in Util/IO/ZIPProvider.h:48


function
Util::ZIPProvider::makeDirRecursive

public virtual
     
     
status_t makeDirRecursive( const FileName & url )

Defined in Util/IO/ZIPProvider.h:49


function
Util::ZIPProvider::remove

public virtual
     
     
status_t remove( const FileName & url )

Defined in Util/IO/ZIPProvider.h:50


function
Util::ZIPProvider::flush

public virtual
   
   
void flush( )

If some kind of internal caching is used, all data should be written to disk

Note: May block if needed

Defined in Util/IO/ZIPProvider.h:52