DataSourceStream.h

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/anakod/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * DataSourceStream.h
 *
 ****/

#ifndef _SMING_CORE_DATA_STREAM_DATA_SOURCE_STREAM_H_
#define _SMING_CORE_DATA_STREAM_DATA_SOURCE_STREAM_H_

#include <user_config.h>
#include "Stream.h"
#include "WString.h"

enum StreamType {
    eSST_Invalid,   
    eSST_Memory,     
    eSST_File,       
    eSST_Template,   
    eSST_JsonObject, 
    eSST_User,       
    eSST_Unknown     
};
class IDataSourceStream : public Stream
{
public:
    virtual StreamType getStreamType() const
    {
        return eSST_Unknown;
    }

    virtual bool isValid() const
    {
        return getStreamType() != eSST_Invalid;
    }

    virtual uint16_t readMemoryBlock(char* data, int bufSize) = 0;

    int read() override;

    int peek() override;

    virtual bool seek(int len) = 0;

    virtual bool isFinished() = 0;

    virtual int available()
    {
        return -1;
    }

    /*
     * From Stream class: We don't write using this stream
     */
    size_t write(uint8_t charToWrite) override
    {
        return 0;
    }

    int length() SMING_DEPRECATED
    {
        return available();
    }

    /*
     * @brief Flushes the stream
     */
    void flush() override
    {
    }

    virtual String id() const
    {
        return nullptr;
    }

    virtual String getName() const
    {
        return nullptr;
    }
};

#endif /* _SMING_CORE_DATA_STREAM_DATA_SOURCE_STREAM_H_ */