ArchiveStream Class Reference
#include <ArchiveStream.h>
Inheritance diagram for ArchiveStream:
Collaboration diagram for ArchiveStream:
Public Member Functions | |
| ArchiveStream (VolumeInfo volumeInfo, String rootPath=nullptr, Flags flags=0) | |
 Public Member Functions inherited from IFS::FWFS::ArchiveStream | |
| ArchiveStream (FileSystem *fileSystem, VolumeInfo volumeInfo, String rootPath=nullptr, Flags flags=0) | |
| Construct an archive stream. More... | |
| ~ArchiveStream () | |
| virtual bool | filterStat (const Stat &stat) |
| Override this method to filter items. More... | |
| void | onFilterStat (FilterStatCallback callback) |
| virtual IBlockEncoder * | createEncoder (FileInfo &file) |
| Override this method to implement custom encoding such as compression or encryption. More... | |
| void | onCreateEncoder (CreateEncoderCallback callback) |
| const String & | getCurrentPath () const |
| Get the current path being processed. More... | |
| uint16_t | readMemoryBlock (char *data, int bufSize) override |
| Read a block of memory. More... | |
| int | seekFrom (int offset, SeekOrigin origin) override |
| Change position in stream. More... | |
| bool | isFinished () override |
| Check if all data has been read. More... | |
| MimeType | getMimeType () const override |
| Get MIME type for stream content. More... | |
| bool | isSuccess () const |
| void | reset () |
| Reset stream to beginning. More... | |
| Public Member Functions inherited from IFS::FsBase | |
| FsBase (IFileSystem *filesys) | |
| bool | isValid () const |
| int | getLastError () |
| determine if an error occurred during operation More... | |
| String | getErrorString (int err) const |
| String | getLastErrorString () const |
| FileSystem * | getFileSystem () const |
| Public Member Functions inherited from IDataSourceStream | |
| virtual StreamType | getStreamType () const |
| Get the stream type. More... | |
| virtual bool | isValid () const |
| Determine if the stream object contains valid data. More... | |
| size_t | readBytes (char *buffer, size_t length) override |
| Read chars from stream into buffer. More... | |
| int | read () override |
| Read one character and moves the stream pointer. More... | |
| int | peek () override |
| Read a character without advancing the stream pointer. More... | |
| virtual bool | seek (int len) |
| Move read cursor. More... | |
| virtual int | available () |
| Return the total length of the stream. More... | |
| size_t | write (uint8_t charToWrite) override |
| From Stream class: We don't write using this stream. More... | |
| int | length () |
| Return the total length of the stream. More... | |
| void | flush () override |
| virtual String | id () const |
| Returns unique id of the resource. More... | |
| virtual String | getName () const |
| Returns name of the resource. More... | |
| String | readString (size_t maxLen) override |
| Overrides Stream method for more efficient reading. More... | |
| virtual bool | moveString (String &s) |
| Memory-based streams may be able to move content into a String. More... | |
| Public Member Functions inherited from Stream | |
| Stream () | |
| void | setTimeout (unsigned long timeout) |
| Set maximum milliseconds to wait for stream data, default is 1 second. More... | |
| bool | find (const char *target) |
| Read data from the stream until the target string is found. More... | |
| bool | find (const char *target, size_t length) |
| Read data from the stream until the target string of given length is found. More... | |
| bool | findUntil (const char *target, const char *terminator) |
As find() but search ends if the terminator string is found. More... | |
| bool | findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen) |
As findUntil(const char*, const char*) but search ends if the terminate string is found. More... | |
| long | parseInt () |
| Returns the first valid (long) integer value from the current position. More... | |
| float | parseFloat () |
| float version of parseInt More... | |
| size_t | readBytesUntil (char terminator, char *buffer, size_t length) |
As readBytes() with terminator character. More... | |
| String | readStringUntil (char terminator) |
| virtual int | indexOf (char c) |
| Public Member Functions inherited from Print | |
| virtual | ~Print () |
| int | getWriteError () |
| Gets last error. More... | |
| void | clearWriteError () |
| Clears the last write error. More... | |
| size_t | write (const char *str) |
| Writes a c-string to output stream. More... | |
| virtual size_t | write (const uint8_t *buffer, size_t size) |
| Writes characters from a buffer to output stream. More... | |
| size_t | write (const char *buffer, size_t size) |
| Writes characters from a buffer to output stream. More... | |
| size_t | print (char c) |
| Prints a single character to output stream. More... | |
| size_t | print (const char str[]) |
| Prints a c-string to output stream. More... | |
| size_t | print (double num, int digits=2) |
| Print a floating-point number to output stream. More... | |
| size_t | print (const Printable &p) |
| Prints a Printable object to output stream. More... | |
| size_t | print (const String &s) |
| Prints a String to output stream. More... | |
| size_t | println () |
| Prints a newline to output stream. More... | |
| size_t | println (const char str[]) |
| Prints a c-string to output stream, appending newline. More... | |
| size_t | println (char c) |
| Prints a single character to output stream, appending newline. More... | |
| size_t | println (double num, int digits=2) |
| Print a floating-point number to output stream, appending newline. More... | |
| size_t | println (const Printable &p) |
| Prints a Printable object to output stream, appending newline. More... | |
| size_t | println (const String &s) |
| Prints a String to output stream, appending newline. More... | |
| size_t | printf (const char *fmt,...) __attribute__((format(printf |
| Prints a formatted c-string to output stream. More... | |
| size_t | print (unsigned long num, int base=DEC) |
| size_t | print (const unsigned long long &num, int base=DEC) |
| size_t | print (long, int base=DEC) |
| size_t | print (const long long &, int base=DEC) |
| size_t | print (unsigned int num, int base=DEC) |
| size_t | print (unsigned char num, int base=DEC) |
| size_t | print (int num, int base=DEC) |
| size_t | println (unsigned char num, int base=DEC) |
| size_t | println (unsigned int num, int base=DEC) |
| size_t | println (unsigned long num, int base=DEC) |
| size_t | println (const unsigned long long &num, int base=DEC) |
| size_t | println (int num, int base=DEC) |
| size_t | println (long num, int base=DEC) |
| size_t | println (const long long &num, int base=DEC) |
Additional Inherited Members | |
| Public Types inherited from IFS::FWFS::ArchiveStream | |
| enum | Flag { Flag::IncludeMountPoints } |
| using | Flags = BitSet< uint8_t, Flag, 1 > |
| using | FilterStatCallback = Delegate< bool(const Stat &stat)> |
| using | CreateEncoderCallback = Delegate< IBlockEncoder *(FileInfo &file)> |
| Protected Member Functions inherited from IFS::FsBase | |
| bool | check (int res) |
| Check file operation result and note error code. More... | |
| Protected Member Functions inherited from Stream | |
| int | timedRead () |
| int | timedPeek () |
| int | peekNextDigit () |
| returns the next numeric digit in the stream or -1 if timeout More... | |
| long | parseInt (char skipChar) |
Like regular parseInt() but the given skipChar is ignored. More... | |
| float | parseFloat (char skipChar) |
Like parseInt(skipChar) for float. More... | |
| Protected Member Functions inherited from Print | |
| void | setWriteError (int err=1) |
| Protected Attributes inherited from IFS::FsBase | |
| int | lastError {FS_OK} |
| Protected Attributes inherited from Stream | |
| uint16_t | receiveTimeout = 1000 |
| number of milliseconds to wait for the next char before aborting timed read More... | |
Constructor & Destructor Documentation
◆ ArchiveStream()
|
inline |
The documentation for this class was generated from the following file:
