#include <FileSystemHandle.h>

Inheritance diagram for mbed::FileSystemHandle:

Public Member Functions
virtual	~FileSystemHandle ()

virtual int	open (FileHandle *file, const char filename, int flags)=0

virtual int	open (DirHandle *dir, const char path)

virtual int	remove (const char *path)

virtual int	rename (const char path, const char newpath)

virtual int	stat (const char path, struct stat st)

virtual int	mkdir (const char *path, mode_t mode)

virtual int	statvfs (const char path, struct statvfs buf)

Detailed Description

A filesystem-like object is one that can be used to open file-like objects though it by fopen("/name/filename", mode)

Implementations must define at least open (the default definitions of the rest of the functions just return error values).

Note: Synchronization level: Set by subclass

Constructor & Destructor Documentation

virtual mbed::FileSystemHandle::~FileSystemHandle ( )

inlinevirtual

FileSystemHandle lifetime

Member Function Documentation

int FileSystemHandle::mkdir	(	const char *	path,
		mode_t	mode
	)

virtual

Create a directory in the filesystem.

Parameters

path	The name of the directory to create.
mode	The permissions with which to create the directory

Returns: 0 on success, negative error code on failure

Reimplemented in LittleFileSystem, FATFileSystem, and mbed::FileSystem.

virtual int mbed::FileSystemHandle::open	(	FileHandle **	file,
		const char *	filename,
		int	flags
	)

pure virtual

Open a file on the filesystem

Parameters

file	Destination for the handle to a newly created file
filename	The name of the file to open
flags	The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR, bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND

Returns: 0 on success, negative error code on failure

Implemented in mbed::FileSystem.

int FileSystemHandle::open	(	DirHandle **	dir,
		const char *	path
	)

virtual

Open a directory on the filesystem

Parameters

dir	Destination for the handle to the directory
path	Name of the directory to open

Returns: 0 on success, negative error code on failure

Reimplemented in mbed::FileSystem.

int FileSystemHandle::remove ( const char * path )

virtual

Remove a file from the filesystem.

Parameters

path	The name of the file to remove.

Returns: 0 on success, negative error code on failure

Reimplemented in LittleFileSystem, FATFileSystem, and mbed::FileSystem.

int FileSystemHandle::rename	(	const char *	path,
		const char *	newpath
	)

virtual

Rename a file in the filesystem.

Parameters

path	The name of the file to rename.
newpath	The name to rename it to

Returns: 0 on success, negative error code on failure

Reimplemented in LittleFileSystem, FATFileSystem, and mbed::FileSystem.

int FileSystemHandle::stat	(	const char *	path,
		struct stat *	st
	)

virtual

Store information about the file in a stat structure

Parameters

path	The name of the file to find information about
st	The stat buffer to write to

Returns: 0 on success, negative error code on failure

Reimplemented in LittleFileSystem, FATFileSystem, and mbed::FileSystem.

int FileSystemHandle::statvfs	(	const char *	path,
		struct statvfs *	buf
	)

virtual

Store information about the mounted filesystem in a statvfs structure

Parameters

path	The name of the file to find information about
buf	The stat buffer to write to

Returns: 0 on success, negative error code on failure

Reimplemented in LittleFileSystem, FATFileSystem, and mbed::FileSystem.

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

mbed-os/platform/FileSystemHandle.h
mbed-os/platform/FileSystemHandle.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Important Information for this Arm website