Core/FileSystem.h
Go to the documentation of this file.
120 template <typename T> inline FileHandle fileOpen(const T& path, FileOpenFlags flags = File::ReadOnly)
232 template <typename TFileName> inline int fileSetContent(const TFileName& fileName, const char* content, size_t length)
238 template <typename TFileName, typename TContent> inline int fileSetContent(const TFileName& fileName, TContent content)
330 template <typename TFileName> inline size_t fileGetContent(const TFileName& fileName, char* buffer, size_t bufSize)
336 template <typename TFileName> inline size_t fileGetContent(const TFileName& fileName, char* buffer)
Installable File System base class.
Definition: Components/IFS/src/include/IFS/FileSystem.h:40
const char * c_str() const
Get a constant (un-modifiable) pointer to String content.
Definition: WString.h:616
int fileTruncate(FileHandle file, file_size_t newSize)
Truncate (reduce) the size of an open file.
Definition: Core/FileSystem.h:261
int fileRename(const char *oldName, const char *newName)
Rename file.
Definition: Core/FileSystem.h:295
int fileSetACL(FileHandle file, const IFS::ACL &acl)
Set access control information.
Definition: Core/FileSystem.h:516
FileHandle fileOpen(const T &path, FileOpenFlags flags=File::ReadOnly)
Open file by path.
Definition: Core/FileSystem.h:120
int fileSystemCheck()
Perform a consistency check/repair on the active file system.
Definition: Core/FileSystem.h:505
int createDirectory(const T &path)
Create a directory.
Definition: Core/FileSystem.h:548
int fileOpenDir(const char *dirName, DirHandle &dir)
Open a named directory for reading.
Definition: Core/FileSystem.h:432
int fileRead(FileHandle file, void *data, size_t size)
Read from file.
Definition: Core/FileSystem.h:163
IFS::FileSystem::Type fileSystemType()
Get the type of file system currently mounted (if any)
int fileCloseDir(DirHandle dir)
close a directory object
Definition: Core/FileSystem.h:452
IFS::FileSystem * fileMountArchive(const String &filename)
Mount a backup archive.
Definition: Core/FileSystem.h:109
void fileSetFileSystem(IFS::IFileSystem *fileSystem)
Sets the currently active file system.
bool fileMountFileSystem(IFS::IFileSystem *fs)
Mount a constructed filesystem with debug messages.
bool dirExist(const char *dirName)
Check if a directory exists on file system.
Definition: Core/FileSystem.h:414
int fileSetAttr(const T &filename, FileAttributes attr)
Set file attributes.
Definition: Core/FileSystem.h:527
int fileSetContent(const TFileName &fileName, const char *content, size_t length)
Create or replace file with defined content.
Definition: Core/FileSystem.h:232
IFS::FileSystem * getFileSystem()
Get the currently active file system, if any.
Definition: Core/FileSystem.h:64
int fileSystemFormat()
Format the active file system.
Definition: Core/FileSystem.h:496
int fileStats(const char *fileName, FileStat &stat)
Get file statistics.
Definition: Core/FileSystem.h:347
int fileRewindDir(DirHandle dir)
Rewind to start of directory entries.
Definition: Core/FileSystem.h:473
int fileWrite(FileHandle file, const void *data, size_t size)
Write to file.
Definition: Core/FileSystem.h:142
file_offset_t fileSeek(FileHandle file, file_offset_t offset, SeekOrigin origin)
Position file cursor.
Definition: Core/FileSystem.h:175
file_offset_t fileTell(FileHandle file)
Get position in file.
Definition: Core/FileSystem.h:195
bool fileExist(const char *fileName)
Check if a file exists on file system.
Definition: Core/FileSystem.h:398
int fileTouch(FileHandle file)
Update file modification time.
Definition: Core/FileSystem.h:152
int fileSetTime(FileHandle file, time_t mtime)
Set access control information for file.
Definition: Core/FileSystem.h:538
int fileReadDir(DirHandle dir, FileStat &stat)
Read a directory entry.
Definition: Core/FileSystem.h:463
String fileGetErrorString(int err)
get the text for a returned error code
Definition: Core/FileSystem.h:215
String fileGetContent(const TFileName &fileName)
Read content of a file.
Definition: Core/FileSystem.h:313
int fileGetSystemInfo(IFS::FileSystem::Info &info)
Get basic file system information.
Definition: Core/FileSystem.h:482
int createDirectories(const T &path)
Create a directory and all required parent directories.
Definition: Core/FileSystem.h:558
file_size_t fileGetSize(const TFileName &fileName)
Get size of file.
Definition: Core/FileSystem.h:248
FileSystem * mountArchive(FileSystem &fs, const String &filename)
Mount an FWFS archive.
BitSet< uint8_t, FileAttribute, size_t(FileAttribute::MAX)> FileAttributes
File attributes are stored as a bitmask.
Definition: FileAttributes.h:56
Timer2Clock::Ticks< uint32_t > read()
Get elapsed watchdog time since last reset.
Definition: Core/FileSystem.h:37
Definition: Access.h:34