Read-only stream to emit base64-encoded content from source stream. More...

#include <Base64OutputStream.h>

Inheritance diagram for Base64OutputStream:

Collaboration diagram for Base64OutputStream:

Public Member Functions
	Base64OutputStream (IDataSourceStream *stream, size_t resultSize=500)
	Stream that transforms bytes of data into base64 data stream. More...

size_t	transform (const uint8_t source, size_t sourceLength, uint8_t target, size_t targetLength) override
	Inherited class implements this method to transform a block of data. More...

void	saveState () override
	A method that backs up the current state. More...

void	restoreState () override
	A method that restores the last backed up state. More...

Public Member Functions inherited from StreamTransformer
	StreamTransformer (IDataSourceStream *stream, size_t resultSize=256, size_t blockSize=64)

StreamType	getStreamType () const override
	Get the stream type. More...

int	available () override
	Return the total length of the stream. More...

bool	isValid () const override
	Determine if the stream object contains valid data. More...

uint16_t	readMemoryBlock (char *data, int bufSize) override
	Read a block of memory. More...

bool	seek (int len) override
	Move read cursor. More...

bool	isFinished () override
	Check if all data has been read. More...

String	getName () const override
	Returns name of the resource. More...

Public Member Functions inherited from IDataSourceStream
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 int	seekFrom (int offset, SeekOrigin origin)
	Change position in stream. More...

size_t	write (uint8_t charToWrite) override
	From Stream class: We don't write using this stream. More...

void	flush () override

virtual String	id () const
	Returns unique id 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 ()=default

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)

Public Member Functions inherited from Print
	Print ()=default

	Print (const Print &)=delete

	Print (Print &&)=delete

virtual	~Print ()=default

Print &	operator= (const Print &)=delete

Print &	operator= (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...

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...

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

Read-only stream to emit base64-encoded content from source stream.

Constructor & Destructor Documentation

◆ Base64OutputStream()

Base64OutputStream::Base64OutputStream	(	IDataSourceStream *	stream,
		size_t	resultSize = `500`
	)

Stream that transforms bytes of data into base64 data stream.

Parameters

stream	- source stream
resultSize	The size of the intermediate buffer, created once per object and reused multiple times

Member Function Documentation

◆ restoreState()

void Base64OutputStream::restoreState ( )

inlineoverridevirtual

A method that restores the last backed up state.

Reimplemented from StreamTransformer.

◆ saveState()

void Base64OutputStream::saveState ( )

inlineoverridevirtual

A method that backs up the current state.

Reimplemented from StreamTransformer.

◆ transform()

size_t Base64OutputStream::transform	(	const uint8_t *	in,
		size_t	inLength,
		uint8_t *	out,
		size_t	outLength
	)

overridevirtual

Inherited class implements this method to transform a block of data.

Parameters

in	source data
inLength	source data length
out	output buffer
outLength	size of output buffer

Return values

size_t number of output bytes written

Note: Called with in = nullptr and inLength = 0 at end of input stream

Implements StreamTransformer.

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

Base64OutputStream.h

Public Member Functions