IFS/FileStream.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.
 *
 * FileStream.h
 *
 ****/

#pragma once

#include "../ReadWriteStream.h"
#include <IFS/FsBase.h>

namespace IFS
{
class FileStream : public FsBase, public ReadWriteStream
{
public:
    using FsBase::FsBase;

    ~FileStream()
    {
        close();
    }

    void attach(FileHandle file, size_t size);

    bool open(const Stat& stat, OpenFlags openFlags = OpenFlag::Read);

    bool open(const String& fileName, IFS::OpenFlags openFlags = OpenFlag::Read);

    void close();

    StreamType getStreamType() const override
    {
        return eSST_File;
    }

    size_t write(const uint8_t* buffer, size_t size) override;

    int read() override
    {
        char c;
        return readBytes(&c, 1) ? static_cast<unsigned char>(c) : -1;
    }

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

    uint16_t readMemoryBlock(char* data, int bufSize) override;

    int seekFrom(int offset, SeekOrigin origin) override;

    bool isFinished() override
    {
        auto fs = getFileSystem();
        return fs == nullptr || lastError != FS_OK || fs->eof(handle) != 0;
    }

    String fileName() const;

    bool fileExist() const
    {
        return handle >= 0;
    }

    String getName() const override
    {
        return fileName();
    }

    MimeType getMimeType() const override;

    bool isValid() const override
    {
        return fileExist();
    }

    size_t getPos() const
    {
        return pos;
    }

    size_t getSize() const
    {
        return size;
    }

    int available() override
    {
        return size - pos;
    }

    String id() const override;

    bool truncate(size_t newSize);

    bool truncate()
    {
        return truncate(pos);
    }

private:
    FileHandle handle{-1};
    size_t pos{0};
    size_t size{0};
};

} // namespace IFS