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

#pragma once

#include <spiffs_sming.h>
#include <WVector.h>
#include <WString.h>

typedef signed short file_t; 

enum FileOpenFlags {
    eFO_ReadOnly = SPIFFS_RDONLY,                             
    eFO_WriteOnly = SPIFFS_WRONLY,                            
    eFO_ReadWrite = eFO_ReadOnly | eFO_WriteOnly,             
    eFO_CreateIfNotExist = SPIFFS_CREAT,                      
    eFO_Append = SPIFFS_APPEND,                               
    eFO_Truncate = SPIFFS_TRUNC,                              
    eFO_CreateNewAlways = eFO_CreateIfNotExist | eFO_Truncate 
};

static inline FileOpenFlags operator|(FileOpenFlags lhs, FileOpenFlags rhs)
{
    return (FileOpenFlags)((int)lhs | (int)rhs);
}

typedef enum {
    eSO_FileStart = SPIFFS_SEEK_SET,  
    eSO_CurrentPos = SPIFFS_SEEK_CUR, 
    eSO_FileEnd = SPIFFS_SEEK_END    
} SeekOriginFlags;

file_t fileOpen(const String& name, FileOpenFlags flags);

void fileClose(file_t file);

int fileWrite(file_t file, const void* data, size_t size);

int fileRead(file_t file, void* data, size_t size);

int fileSeek(file_t file, int offset, SeekOriginFlags origin);

bool fileIsEOF(file_t file);

int32_t fileTell(file_t file);

int fileFlush(file_t file);

int fileLastError(file_t fd);

void fileClearLastError(file_t fd);

int fileSetContent(const String& fileName, const char* content, int length = -1);

int fileSetContent(const String& fileName, const String& content);

uint32_t fileGetSize(const String& fileName);

int fileTruncate(file_t file, size_t newSize);

int fileTruncate(file_t file);

int fileTruncate(const String& fileName, size_t newSize);

int fileRename(const String& oldName, const String& newName);

Vector<String> fileList();

String fileGetContent(const String& fileName);

size_t fileGetContent(const String& fileName, char* buffer, size_t bufSize);

int fileStats(const String& name, spiffs_stat* stat);

int fileStats(file_t file, spiffs_stat* stat);

int fileDelete(const String& name);

int fileDelete(file_t file);

bool fileExist(const String& name);