VFS_SPFFS Class Reference

ESP32 Virtual File System for the SPFFS. The default mount point is "/spiffs" DRAFT implementation: not tested See https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card/sdspi. More...

#include <VFS_SPFFS.h>

Inheritance diagram for VFS_SPFFS:

Public Member Functions
	VFS_SPFFS (const char *mountPoint="/spiffs")
bool	begin ()
	mount the file systems
void	end ()
	unmount the file system
bool	exists (const char *path)
bool	exists (const std::string &path)
bool	mkdir (const char *path)
bool	mkdir (const std::string &path)
const char *	mountPoint ()
	provides the actual mount point
VFSFile	open (const char *file, FileMode mode=VFS_FILE_READ)
VFSFile	open (const std::string &path, FileMode mode=VFS_FILE_READ)
bool	remove (const char *path)
bool	remove (const std::string &path)
bool	rename (const char *pathFrom, const char *pathTo)
bool	rename (const std::string &pathFrom, const std::string &pathTo)
bool	rmdir (const char *path)
bool	rmdir (const std::string &path)
void	setFormatIfMountFailed (bool format)
void	setMaxFile (int files)
void	setMountPoint (const char *mp)
	provide the mount point (root directory for the file system)

Protected Member Functions
const char *	expand (const char *file)
	expands the file name with the mount point

Protected Attributes
esp_vfs_spiffs_conf_t	conf
bool	format_if_mount_failed = true
int	max_files = 5
const char *	mount_point = "/"
Str	tmp

Detailed Description

ESP32 Virtual File System for the SPFFS. The default mount point is "/spiffs" DRAFT implementation: not tested See https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card/sdspi.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

VFS_SPFFS()

VFS_SPFFS ( const char *  mountPoint = "/spiffs" )

inline

Member Function Documentation

begin()

bool begin ( )

inlinevirtual

mount the file systems

Reimplemented from VFS.

end()

void end ( )

inlinevirtual

unmount the file system

Reimplemented from VFS.

exists() [1/2]

bool exists ( const char *  path )

inlineinherited

exists() [2/2]

bool exists ( const std::string &  path )

inlineinherited

expand()

const char * expand ( const char *  file )

inlineprotectedinherited

expands the file name with the mount point

mkdir() [1/2]

bool mkdir ( const char *  path )

inlineinherited

mkdir() [2/2]

bool mkdir ( const std::string &  path )

inlineinherited

mountPoint()

const char * mountPoint ( )

inlineinherited

provides the actual mount point

open() [1/2]

VFSFile open ( const char *  file, FileMode  mode = VFS_FILE_READ  )

inlineinherited

open() [2/2]

VFSFile open ( const std::string &  path, FileMode  mode = VFS_FILE_READ  )

inlineinherited

remove() [1/2]

bool remove ( const char *  path )

inlineinherited

remove() [2/2]

bool remove ( const std::string &  path )

inlineinherited

rename() [1/2]

bool rename ( const char *  pathFrom, const char *  pathTo  )

inlineinherited

rename() [2/2]

bool rename ( const std::string &  pathFrom, const std::string &  pathTo  )

inlineinherited

rmdir() [1/2]

bool rmdir ( const char *  path )

inlineinherited

rmdir() [2/2]

bool rmdir ( const std::string &  path )

inlineinherited

setFormatIfMountFailed()

void setFormatIfMountFailed ( bool  format )

inline

setMaxFile()

void setMaxFile ( int  files )

inline

setMountPoint()

void setMountPoint ( const char *  mp )

inlinevirtual

provide the mount point (root directory for the file system)

Reimplemented from VFS.

Member Data Documentation

conf

esp_vfs_spiffs_conf_t conf

protected

format_if_mount_failed

bool format_if_mount_failed = true

protected

max_files

int max_files = 5

protected

mount_point

const char* mount_point = "/"

protectedinherited

tmp

Str tmp

protectedinherited

---

The documentation for this class was generated from the following file:

• src/AudioTools/Disk/VFS_SPFFS.h