public

Inheritance Graph

graph BT
	FSProvider
	FSProvider --> AbstractFSProvider
	click FSProvider "classUtil_1_1FSProvider"
	click AbstractFSProvider "classUtil_1_1AbstractFSProvider"

Description

Standard file system provider for accessing normal files with “file” protocol. E.g. “file://bla/foo.txt”

[ FSProvider ] > [ AbstractFSProvider ]

Public Static Functions

   
   
bool init()

Public Functions

   
   
  FSProvider()
   
  ~FSProvider()
   
status_t readFile(const FileName & file, std::vector< uint8_t > & data)
   
status_t writeFile(const FileName & void, const std::vector< uint8_t > & data, bool overwrite)
   
std::unique_ptr< std::iostream > open(const FileName & filename)
   
std::unique_ptr< std::istream > openForReading(const FileName & filename)
   
std::unique_ptr< std::ostream > openForWriting(const FileName & filename)
   
std::unique_ptr< std::ostream > openForAppending(const FileName & filename)
   
status_t makeDir(const FileName & void)
   
status_t makeDirRecursive(const FileName & void)
   
status_t remove(const FileName & void)
   
status_t dir(const FileName & path, std::list< FileName > & result, uint8_t flags)
   
bool isFile(const FileName & void)
   
bool isDir(const FileName & void)
   
size_t fileSize(const FileName & filename)

Documentation

function
Util::FSProvider::init

public static
   
   
bool init( )

Defined in Util/IO/FSProvider.h:30


function
Util::FSProvider::FSProvider

public
   
   
FSProvider( )

Defined in Util/IO/FSProvider.h:32


function
Util::FSProvider::~FSProvider

public virtual
   
   
~FSProvider( )

Defined in Util/IO/FSProvider.h:33


function
Util::FSProvider::readFile

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

Defined in Util/IO/FSProvider.h:36


function
Util::FSProvider::writeFile

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

Defined in Util/IO/FSProvider.h:37


function
Util::FSProvider::open

public virtual
     
     
std::unique_ptr< std::iostream > open( const FileName & filename )

Defined in Util/IO/FSProvider.h:39


function
Util::FSProvider::openForReading

public virtual
     
     
std::unique_ptr< std::istream > openForReading( const FileName & filename )

Defined in Util/IO/FSProvider.h:40


function
Util::FSProvider::openForWriting

public virtual
     
     
std::unique_ptr< std::ostream > openForWriting( const FileName & filename )

Defined in Util/IO/FSProvider.h:41


function
Util::FSProvider::openForAppending

public virtual
     
     
std::unique_ptr< std::ostream > openForAppending( const FileName & filename )

Defined in Util/IO/FSProvider.h:42


function
Util::FSProvider::makeDir

public virtual
     
     
status_t makeDir( const FileName & void )

Defined in Util/IO/FSProvider.h:44


function
Util::FSProvider::makeDirRecursive

public virtual
     
     
status_t makeDirRecursive( const FileName & void )

Defined in Util/IO/FSProvider.h:45


function
Util::FSProvider::remove

public virtual
     
     
status_t remove( const FileName & void )

Defined in Util/IO/FSProvider.h:46


function
Util::FSProvider::dir

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

Defined in Util/IO/FSProvider.h:48


function
Util::FSProvider::isFile

public virtual
     
     
bool isFile( const FileName & void )

Defined in Util/IO/FSProvider.h:49


function
Util::FSProvider::isDir

public virtual
     
     
bool isDir( const FileName & void )

Defined in Util/IO/FSProvider.h:50


function
Util::FSProvider::fileSize

public virtual
     
     
size_t fileSize( const FileName & filename )

Defined in Util/IO/FSProvider.h:51