| public |
Inheritance Graph
graph BT
AbstractFSProvider
AbstractFSProvider --> ReferenceCounter
ArchiveProvider --> AbstractFSProvider
DBFSProvider --> AbstractFSProvider
FSProvider --> AbstractFSProvider
NetProvider --> AbstractFSProvider
SerialProvider --> AbstractFSProvider
ZIPProvider --> AbstractFSProvider
click AbstractFSProvider "classUtil_1_1AbstractFSProvider"
click ReferenceCounter "classUtil_1_1ReferenceCounter"
click ArchiveProvider "classUtil_1_1ArchiveProvider"
click DBFSProvider "classUtil_1_1DBFSProvider"
click FSProvider "classUtil_1_1FSProvider"
click NetProvider "classUtil_1_1NetProvider"
click SerialProvider "classUtil_1_1SerialProvider"
click ZIPProvider "classUtil_1_1ZIPProvider"
Description
Public Types
| enum | status_t {OK, FAILURE, UNSUPPORTED} |
Public Functions
| AbstractFSProvider() | |
| ~AbstractFSProvider() | |
| bool | exists(const FileName & void) |
| bool | isFile(const FileName & void) |
| bool | isDir(const FileName & void) |
| size_t | fileSize(const FileName & void) |
| status_t | makeDir(const FileName & void) |
| status_t | makeDirRecursive(const FileName & void) |
| status_t | remove(const FileName & void) |
| status_t | removeRecursive(const FileName & void) |
| status_t | dir(const FileName & void, std::list< FileName > & void, uint8_t void) |
| status_t | readFile(const FileName & void, std::vector< uint8_t > & void) |
| status_t | writeFile(const FileName & void, const std::vector< uint8_t > & void, bool void) |
| std::unique_ptr< std::iostream > | open(const FileName & void) |
| std::unique_ptr< std::istream > | openForReading(const FileName & void) |
| std::unique_ptr< std::ostream > | openForWriting(const FileName & void) |
| std::unique_ptr< std::ostream > | openForAppending(const FileName & void) |
| void | flush() |
Public Static Functions
| std::string | getStatusMessage(const status_t status) |
Documentation
enum
Util::AbstractFSProvider::status_t
| public |
| enum status_t |
| Enumerator | Description | |
|---|---|---|
| Enumerator | Description | |
| OK | ||
| FAILURE | ||
| UNSUPPORTED |
Defined in Util/IO/AbstractFSProvider.h:35
function
Util::AbstractFSProvider::AbstractFSProvider
| public |
| AbstractFSProvider( | ) |
Defined in Util/IO/AbstractFSProvider.h:32
function
Util::AbstractFSProvider::~AbstractFSProvider
| public | virtual |
| ~AbstractFSProvider( | ) |
Defined in Util/IO/AbstractFSProvider.h:33
function
Util::AbstractFSProvider::exists
| public | inline | virtual |
| bool exists( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:40
function
Util::AbstractFSProvider::isFile
| public | inline | virtual |
| bool isFile( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:41
function
Util::AbstractFSProvider::isDir
| public | inline | virtual |
| bool isDir( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:42
function
Util::AbstractFSProvider::fileSize
| public | inline | virtual |
| size_t fileSize( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:43
function
Util::AbstractFSProvider::makeDir
| public | inline | virtual |
| status_t makeDir( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:45
function
Util::AbstractFSProvider::makeDirRecursive
| public | inline | virtual |
| status_t makeDirRecursive( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:46
function
Util::AbstractFSProvider::remove
| public | inline | virtual |
| status_t remove( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:48
function
Util::AbstractFSProvider::removeRecursive
| public | virtual |
| status_t removeRecursive( | const FileName & | void ) |
standard implementation uses dir and remove calls to delete all contained files and dirs for their own
Defined in Util/IO/AbstractFSProvider.h:50
function
Util::AbstractFSProvider::dir
| public | inline | virtual |
| status_t dir( | const FileName & | void, |
| std::list< FileName > & | void, | |
| uint8_t | void | |
| ) |
Defined in Util/IO/AbstractFSProvider.h:52
function
Util::AbstractFSProvider::readFile
| public | inline | virtual |
| status_t readFile( | const FileName & | void, |
| std::vector< uint8_t > & | void | |
| ) |
Defined in Util/IO/AbstractFSProvider.h:54
function
Util::AbstractFSProvider::writeFile
| public | inline | virtual |
| status_t writeFile( | const FileName & | void, |
| const std::vector< uint8_t > & | void, | |
| bool | void | |
| ) |
Defined in Util/IO/AbstractFSProvider.h:55
function
Util::AbstractFSProvider::open
| public | inline | virtual |
| std::unique_ptr< std::iostream > open( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:57
function
Util::AbstractFSProvider::openForReading
| public | inline | virtual |
| std::unique_ptr< std::istream > openForReading( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:58
function
Util::AbstractFSProvider::openForWriting
| public | inline | virtual |
| std::unique_ptr< std::ostream > openForWriting( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:59
function
Util::AbstractFSProvider::openForAppending
| public | inline | virtual |
| std::unique_ptr< std::ostream > openForAppending( | const FileName & | void ) |
Defined in Util/IO/AbstractFSProvider.h:60
function
Util::AbstractFSProvider::flush
| public | inline | 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/AbstractFSProvider.h:64
function
Util::AbstractFSProvider::getStatusMessage
| public | static |
| std::string getStatusMessage( | const status_t | status ) |
Defined in Util/IO/AbstractFSProvider.h:38