Storage::PartitionStream Class Reference
Stream operating directory on a Storage partition. More...
#include <PartitionStream.h>
Inheritance diagram for Storage::PartitionStream:
Collaboration diagram for Storage::PartitionStream:
Public Member Functions | |
PartitionStream (Partition partition, uint32_t offset, size_t size) | |
PartitionStream (Partition partition) | |
int | available () override |
Return the total length of the stream. 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... | |
size_t | write (const uint8_t *buffer, size_t size) override |
Write chars to stream. More... | |
bool | isFinished () override |
Check if all data has been read. More... | |
![]() | |
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 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... | |
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... | |
virtual MimeType | getMimeType () const |
Get MIME type for stream content. 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... | |
![]() | |
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) |
![]() | |
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... | |
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 | |
![]() | |
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... | |
![]() | |
void | setWriteError (int err=1) |
![]() | |
uint16_t | receiveTimeout = 1000 |
number of milliseconds to wait for the next char before aborting timed read More... | |
Detailed Description
Stream operating directory on a Storage partition.
To support write operations, the target region must be erased first.
Constructor & Destructor Documentation
◆ PartitionStream() [1/2]
|
inline |
◆ PartitionStream() [2/2]
|
inline |
Member Function Documentation
◆ available()
|
inlineoverridevirtual |
Return the total length of the stream.
- Return values
-
int -1 is returned when the size cannot be determined
Reimplemented from IDataSourceStream.
◆ isFinished()
|
inlineoverridevirtual |
◆ readMemoryBlock()
Read a block of memory.
- Parameters
-
data Pointer to the data to be read bufSize Quantity of chars to read
- Return values
-
uint16_t Quantity of chars read
- Todo:
- Should IDataSourceStream::readMemoryBlock return same data type as its bufSize param?
Implements IDataSourceStream.
◆ seekFrom()
|
overridevirtual |
Change position in stream.
- Parameters
-
offset origin
- Return values
-
New position, < 0 on error
- Note
- This method is implemented by streams which support random seeking, such as files and memory streams.
Reimplemented from IDataSourceStream.
◆ write()
|
overridevirtual |
Write chars to stream.
- Parameters
-
buffer Pointer to buffer to write to the stream size Quantity of chars to write
- Return values
-
size_t Quantity of chars written to stream
- Note
- Although this is defined in the Print class, ReadWriteStream uses this as the core output method so descendants are required to implement it
Implements ReadWriteStream.
The documentation for this class was generated from the following file: