public

Inheritance Graph

graph BT
	ArchiveProvider
	ArchiveProvider --> AbstractFSProvider
	click ArchiveProvider "classUtil_1_1ArchiveProvider"
	click AbstractFSProvider "classUtil_1_1AbstractFSProvider"

Description

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

Author: Benjamin Eikel

Date: 2012-10-11

Public Static Functions

   
   
bool init()

Public Functions

   
   
  ArchiveProvider()
   
  ~ArchiveProvider()
   
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::ArchiveProvider::init

public static
   
   
bool init( )

Defined in Util/IO/ArchiveProvider.h:36


function
Util::ArchiveProvider::ArchiveProvider

public
   
   
ArchiveProvider( )

Defined in Util/IO/ArchiveProvider.h:38


function
Util::ArchiveProvider::~ArchiveProvider

public virtual
   
   
~ArchiveProvider( )

Defined in Util/IO/ArchiveProvider.h:39


function
Util::ArchiveProvider::readFile

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

Defined in Util/IO/ArchiveProvider.h:41


function
Util::ArchiveProvider::writeFile

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

Defined in Util/IO/ArchiveProvider.h:42


function
Util::ArchiveProvider::dir

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

Defined in Util/IO/ArchiveProvider.h:44


function
Util::ArchiveProvider::isFile

public virtual
     
     
bool isFile( const FileName & url )

Defined in Util/IO/ArchiveProvider.h:45


function
Util::ArchiveProvider::isDir

public virtual
     
     
bool isDir( const FileName & url )

Defined in Util/IO/ArchiveProvider.h:46


function
Util::ArchiveProvider::fileSize

public virtual
     
     
size_t fileSize( const FileName & url )

Defined in Util/IO/ArchiveProvider.h:47


function
Util::ArchiveProvider::makeDir

public virtual
     
     
status_t makeDir( const FileName & url )

Defined in Util/IO/ArchiveProvider.h:49


function
Util::ArchiveProvider::makeDirRecursive

public virtual
     
     
status_t makeDirRecursive( const FileName & url )

Defined in Util/IO/ArchiveProvider.h:50


function
Util::ArchiveProvider::remove

public virtual
     
     
status_t remove( const FileName & url )

Defined in Util/IO/ArchiveProvider.h:51


function
Util::ArchiveProvider::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/ArchiveProvider.h:53