VFS Class Reference

Base class which uses c++ file functions. It is also used as base class for an ESP32 Virtual File System. After initializing the VFS the regular c file operations are supported. More...

#include <VFS.h>

Inheritance diagram for VFS:

Public Member Functions
virtual bool	begin ()
	mount the file systems
virtual 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)
virtual 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
const char *	mount_point = "/"
Str	tmp

Detailed Description

Base class which uses c++ file functions. It is also used as base class for an ESP32 Virtual File System. After initializing the VFS the regular c file operations are supported.

Note

Supported only by ESP32 (Arduino and IDF)

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

begin()

virtual bool begin ( )

inlinevirtual

mount the file systems

Reimplemented in VFS_LittleFS, VFS_Multi, VFS_SDMMC, VFS_SDSPI, and VFS_SPFFS.

end()

virtual void end ( )

inlinevirtual

unmount the file system

Reimplemented in VFS_LittleFS, VFS_Multi, VFS_SDMMC, VFS_SDSPI, and VFS_SPFFS.

exists() [1/2]

bool exists ( const char * path )

inline

exists() [2/2]

bool exists ( const std::string & path )

inline

expand()

const char * expand ( const char * file )

inlineprotected

expands the file name with the mount point

mkdir() [1/2]

bool mkdir ( const char * path )

inline

mkdir() [2/2]

bool mkdir ( const std::string & path )

inline

mountPoint()

const char * mountPoint ( )

inline

provides the actual mount point

open() [1/2]

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

inline

open() [2/2]

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

inline

remove() [1/2]

bool remove ( const char * path )

inline

remove() [2/2]

bool remove ( const std::string & path )

inline

rename() [1/2]

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

inline

rename() [2/2]

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

inline

rmdir() [1/2]

bool rmdir ( const char * path )

inline

rmdir() [2/2]

bool rmdir ( const std::string & path )

inline

setMountPoint()

virtual void setMountPoint ( const char * mp )

inlinevirtual

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

Reimplemented in VFS_LittleFS, VFS_Multi, VFS_SDMMC, VFS_SDSPI, and VFS_SPFFS.

Member Data Documentation

mount_point

const char* mount_point = "/"

protected

tmp

Str tmp

protected

---

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

• src/AudioTools/Disk/VFS.h