JsonObject stream class. More...

#include <JsonObjectStream.h>

Inheritance diagram for JsonObjectStream:
[legend]
Collaboration diagram for JsonObjectStream:
[legend]

Public Member Functions

 JsonObjectStream (Json::SerializationFormat format, size_t capacity=1024)
 Create a JSON object stream with a specific format. More...
 
 JsonObjectStream (size_t capacity=1024)
 Create a JSON object stream using default (Compact) format. More...
 
StreamType getStreamType () const override
 Get the stream type. More...
 
JsonObject getRoot ()
 Get the JSON root node. More...
 
uint16_t readMemoryBlock (char *data, int bufSize) override
 Read a block of memory. More...
 
int available () override
 Return the total length of the stream. More...
 
bool isFinished () override
 Check if all data has been read. More...
 
- Public Member Functions inherited from MemoryDataStream
 MemoryDataStream (size_t maxCapacity=UINT16_MAX)
 
 MemoryDataStream (String &&string) noexcept
 Stream takes ownership of String content using move semantics. More...
 
 ~MemoryDataStream ()
 
const char * getStreamPointer () const
 Get a pointer to the current position. More...
 
size_t write (const uint8_t *buffer, size_t size) override
 Write chars to end of stream. More...
 
int seekFrom (int offset, SeekOrigin origin) override
 Change position in stream. More...
 
bool moveString (String &s) override
 Memory-based streams may be able to move content into a String. More...
 
bool ensureCapacity (size_t minCapacity)
 Pre-allocate stream to given size. More...
 
void clear ()
 Clear data from stream and reset to start, but keep buffer allocated. More...
 
size_t getSize () const
 
size_t getCapacity () 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...
 
- Public Member Functions inherited from IDataSourceStream
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...
 
- 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...
 
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

- 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

JsonObject stream class.

Constructor & Destructor Documentation

◆ JsonObjectStream() [1/2]

JsonObjectStream::JsonObjectStream ( Json::SerializationFormat  format,
size_t  capacity = 1024 
)
inline

Create a JSON object stream with a specific format.

Parameters
format
capacitySize of JSON buffer

◆ JsonObjectStream() [2/2]

JsonObjectStream::JsonObjectStream ( size_t  capacity = 1024)
inline

Create a JSON object stream using default (Compact) format.

Parameters
capacitySize of JSON buffer

Member Function Documentation

◆ available()

int JsonObjectStream::available ( )
inlineoverridevirtual

Return the total length of the stream.

Return values
int-1 is returned when the size cannot be determined

Reimplemented from MemoryDataStream.

◆ getRoot()

JsonObject JsonObjectStream::getRoot ( )
inline

Get the JSON root node.

Return values
JsonObjectReference to the root node

◆ getStreamType()

StreamType JsonObjectStream::getStreamType ( ) const
inlineoverridevirtual

Get the stream type.

Return values
StreamTypeThe stream type.

Reimplemented from MemoryDataStream.

◆ isFinished()

bool JsonObjectStream::isFinished ( )
inlineoverridevirtual

Check if all data has been read.

Return values
boolTrue on success.

Reimplemented from MemoryDataStream.

◆ readMemoryBlock()

uint16_t JsonObjectStream::readMemoryBlock ( char *  data,
int  bufSize 
)
inlineoverridevirtual

Read a block of memory.

Parameters
dataPointer to the data to be read
bufSizeQuantity of chars to read
Return values
uint16_tQuantity of chars read
Todo:
Should IDataSourceStream::readMemoryBlock return same data type as its bufSize param?

Reimplemented from MemoryDataStream.


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