Host File stream class. More...

#include <HostFileStream.h>

Inheritance diagram for HostFileStream:
Collaboration diagram for HostFileStream:

Public Member Functions

 HostFileStream ()
 
 HostFileStream (const String &fileName, IFS::OpenFlags openFlags=IFS::OpenFlag::Read)
 
- Public Member Functions inherited from IFS::FileStream
 ~FileStream ()
 
void attach (FileHandle file, size_t size)
 Attach this stream object to an open file handle. More...
 
bool open (const String &fileName, IFS::OpenFlags openFlags=OpenFlag::Read)
 Open a file by path, and attach this stream object to it. More...
 
void close ()
 Close file. More...
 
StreamType getStreamType () const override
 Get the stream type. More...
 
size_t write (const uint8_t *buffer, size_t size) override
 Write chars to stream. More...
 
int read () override
 Read one character and moves the stream pointer. More...
 
size_t readBytes (char *buffer, size_t length) override
 Read chars from stream into buffer. 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...
 
String fileName () const
 Filename of file stream is attached to. More...
 
bool fileExist () const
 Determine if file exists. More...
 
String getName () const override
 Returns name of the resource. More...
 
MimeType getMimeType () const override
 Get MIME type for stream content. More...
 
bool isValid () const override
 Determine if the stream object contains valid data. More...
 
size_t getPos () const
 Get the offset of cursor from beginning of data. More...
 
size_t getSize () const
 Get the total file size. More...
 
int available () override
 Return the maximum bytes available to read, from current position. More...
 
String id () const override
 Returns unique id of the resource. More...
 
bool truncate (size_t newSize)
 Reduce the file size. More...
 
bool truncate ()
 Truncate file at current position. More...
 
bool stat (Stat &s)
 
 FsBase (IFileSystem *filesys=nullptr)
 
- Public Member Functions inherited from IFS::FsBase
 FsBase (IFileSystem *filesys=nullptr)
 
bool isValid () const
 
int getLastError ()
 determine if an error occurred during operation More...
 
String getErrorString (int err) const
 
String getLastErrorString () const
 
FileSystemgetFileSystem () const
 
- Public Member Functions inherited from ReadWriteStream
size_t write (uint8_t charToWrite) override
 From Stream class: We don't write using this stream. More...
 
virtual size_t copyFrom (IDataSourceStream *source, size_t size=SIZE_MAX)
 Copy data from a source stream. More...
 
virtual size_t write (uint8_t c)=0
 Writes a single character to output stream. 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...
 
- Public Member Functions inherited from IDataSourceStream
int peek () override
 Read a character without advancing the stream pointer. More...
 
virtual bool seek (int len)
 Move read cursor. More...
 
void flush () override
 
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...
 
virtual size_t readBytes (char *buffer, size_t length)
 Read chars from stream into buffer. More...
 
size_t readBytes (uint8_t *buffer, size_t length)
 
- 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 readBytes (uint8_t *buffer, size_t length)
 
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
 Print ()
 
 Print (const Print &)=delete
 
 Print (Print &&)=delete
 
virtual ~Print ()
 
Printoperator= (const Print &)=delete
 
Printoperator= (Print &&)=delete
 
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...
 
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...
 
template<typename T >
std::enable_if< has_printTo< T >::value, size_t >::type print (const T &obj)
 Prints a Printable object to output stream. More...
 
size_t print (const String &s)
 Prints a String to output stream. More...
 
template<typename E >
std::enable_if< std::is_enum< E >::value &&!std::is_convertible< E, int >::value, size_t >::type print (E value)
 enums can be printed as strings provided they have a toString(E) implementation. More...
 
size_t println ()
 Prints a newline to output stream. More...
 
template<typename... Args>
size_t println (const Args &... args)
 Print value plus newline to output stream. More...
 
size_t printf (const char *fmt,...)
 Prints a formatted c-string to output stream. More...
 
size_t print (unsigned long num, uint8_t base=DEC)
 
template<typename... Args>
size_t print (unsigned long num, Args... args)
 
template<typename... Args>
size_t print (const unsigned long long &num, Args... args)
 
size_t print (long num, uint8_t base=DEC)
 
template<typename... Args>
size_t print (long num, Args... args)
 
template<typename... Args>
size_t print (const long long &num, Args... args)
 
template<typename... Args>
size_t print (unsigned int num, Args... args)
 
template<typename... Args>
size_t print (unsigned char num, Args... args)
 
template<typename... Args>
size_t print (int num, Args... args)
 

Additional Inherited Members

- Protected Member Functions inherited from IFS::FsBase
bool check (int64_t 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...
 

Detailed Description

Host File stream class.

Constructor & Destructor Documentation

◆ HostFileStream() [1/2]

HostFileStream::HostFileStream ( )

◆ HostFileStream() [2/2]

HostFileStream::HostFileStream ( const String fileName,
IFS::OpenFlags  openFlags = IFS::OpenFlag::Read 
)
inline

The documentation for this class was generated from the following file: