DataSourceStream.h

Go to the documentation of this file.

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

#pragma once

#include <Stream.h>
#include <WString.h>
#include "SeekOrigin.h"
#include "../WebConstants.h"

enum StreamType {
    eSST_Invalid,        
    eSST_Memory,         
    eSST_MemoryWritable, 
                         //  Expands on demand and does not transform the data.
    eSST_File,           
    eSST_Template,       
    eSST_JsonObject,     
    eSST_User,           
    eSST_Chain,          
    eSST_Transform,      
    eSST_Wrapper,        
    eSST_HeaderChecker,  
    eSST_Unknown         
};

class IDataSourceStream : public Stream
{
public:
    virtual StreamType getStreamType() const
    {
        return eSST_Unknown;
    }

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

    using Stream::readBytes;

    size_t readBytes(char* buffer, size_t length) override;

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

    int read() override;

    int peek() override;

    virtual int seekFrom(int offset, SeekOrigin origin)
    {
        return -1;
    }

    virtual bool seek(int len)
    {
        return seekFrom(len, SeekOrigin::Current) >= 0;
    }

    virtual bool isFinished() = 0;

    virtual int available()
    {
        return -1;
    }

    size_t write(uint8_t charToWrite) override
    {
        (void)charToWrite;
        return 0;
    }

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

    virtual String id() const
    {
        return nullptr;
    }

    virtual String getName() const
    {
        return nullptr;
    }

    virtual MimeType getMimeType() const
    {
        return ContentType::fromFullFileName(getName(), MIME_UNKNOWN);
    }

    String readString(size_t maxLen) override;

    virtual bool moveString(String& s)
    {
        s = nullptr;
        return false;
    };
};