ReadWriteStream Class Reference

Base class for read/write stream. More...

#include <ReadWriteStream.h>

Inheritance diagram for ReadWriteStream:

Collaboration diagram for ReadWriteStream:

Public Member Functions
size_t	write (uint8_t charToWrite) override
	From Stream class: We don't write using this stream. More...
virtual size_t	write (const uint8_t *buffer, size_t size)=0
	Write chars to 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
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...
virtual uint16_t	readMemoryBlock (char *data, int bufSize)=0
	Read a block of memory. 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 int	seekFrom (int offset, SeekOrigin origin)
	Change position in stream. More...
virtual bool	seek (int len)
	Move read cursor. More...
virtual bool	isFinished ()=0
	Check if all data has been read. More...
virtual int	available ()
	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...
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
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...
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 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 Stream
uint16_t	receiveTimeout = 1000
	number of milliseconds to wait for the next char before aborting timed read More...

Detailed Description

Base class for read/write stream.

Member Function Documentation

copyFrom()

virtual size_t ReadWriteStream::copyFrom ( IDataSourceStream *  source, size_t  size = SIZE_MAX  )

virtual

Copy data from a source stream.

Parameters

source	Stream to read data from
size	Quantity of chars to write, determines size of intermediate buffer to use

Return values

size_t

Quantity of chars actually written, may be less than requested

write() [1/6]

size_t Print::write

inline

Writes characters from a buffer to output stream.

Parameters

buffer	Pointer to character buffer
size	Quantity of characters to write

Return values

size_t

Quantity of characters written to stream

write() [2/6]

size_t Print::write

inline

Writes a c-string to output stream.

Parameters

str	Pointer to c-string

Return values

size_t

Quantity of characters written to stream

write() [3/6]

virtual size_t Print::write

Writes characters from a buffer to output stream.

Parameters

buffer	Pointer to character buffer
size	Quantity of characters to write

Return values

size_t

Quantity of characters written to stream

write() [4/6]

virtual size_t ReadWriteStream::write ( const uint8_t *  buffer, size_t  size  )

pure virtual

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

Reimplemented from Print.

Implemented in OtaUpgrade::EncryptedStream, OtaUpgrade::BasicStream, Ota::UpgradeOutputStream, CircularBuffer, USB::VENDOR::Device, USB::CDC::HostDevice, USB::CDC::Device, PartCheckerStream, HardwareSerial, MemoryDataStream, LimitedWriteStream, LimitedMemoryStream, IFS::FileStream, EndlessMemoryStream, and Storage::PartitionStream.

write() [5/6]

virtual size_t Print::write

Writes a single character to output stream.

Parameters

c	Character to write to output stream

Return values

size_t

Quantity of characters written to output stream

write() [6/6]

size_t ReadWriteStream::write ( uint8_t  charToWrite )

inlineoverridevirtual

From Stream class: We don't write using this stream.

Parameters

charToWrite

Reimplemented from IDataSourceStream.

---

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

• ReadWriteStream.h