A filesystem for accessing the local mbed Microcontroller USB disk drive. More...

#include <LocalFileSystem.h>

Inherits mbed::FileSystemLike, NonCopyable< LocalFileSystem >, mbed::FileSystemLike, and NonCopyable< LocalFileSystem >.

Public Member Functions
virtual int	open (FileHandle *file, const char path, int flags)
	Open a file on the filesystem.
virtual int	open (DirHandle *dir, const char name)
	Open a directory on the filesystem.
virtual int	remove (const char *filename)
	Remove a file from the filesystem.
virtual int	open (FileHandle *file, const char path, int flags)
	Open a file on the filesystem.
virtual int	open (DirHandle *dir, const char name)
	Open a directory on the filesystem.
virtual int	remove (const char *filename)
	Remove a file from the filesystem.
	MBED_DEPRECATED_SINCE ("mbed-os-5.5","Replaced by `int open(FileHandle *, ...)` for propagating error codes") FileHandle open(const char *path
	Open a file on the filesystem.
	MBED_DEPRECATED_SINCE ("mbed-os-5.5","Replaced by `int open(FileHandle *, ...)` for propagating error codes") FileHandle open(const char *path
	Open a file on the filesystem.
virtual int	rename (const char path, const char newpath)
	Rename a file in the filesystem.
virtual int	rename (const char path, const char newpath)
	Rename a file in the filesystem.
virtual int	stat (const char path, struct stat st)
	Store information about the file in a stat structure.
virtual int	stat (const char path, struct stat st)
	Store information about the file in a stat structure.
virtual int	mkdir (const char *path, mode_t mode)
	Create a directory in the filesystem.
virtual int	mkdir (const char *path, mode_t mode)
	Create a directory in the filesystem.
virtual int	statvfs (const char path, struct statvfs buf)
	Store information about the mounted filesystem in a statvfs structure.
virtual int	statvfs (const char path, struct statvfs buf)
	Store information about the mounted filesystem in a statvfs structure.
Protected Member Functions
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.
Private Member Functions
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.

Detailed Description

A filesystem for accessing the local mbed Microcontroller USB disk drive.

This allows programs to read and write files on the same disk drive that is used to program the mbed Microcontroller. Once created, the standard C file access functions are used to open, read and write files.

Note:: Synchronization level: Thread safe

Example:

 #include "mbed.h"

 LocalFileSystem local("local");               // Create the local filesystem under the name "local"

 int main() {
     FILE *fp = fopen("/local/out.txt", "w");  // Open "out.txt" on the local file system for writing
     fprintf(fp, "Hello World!");
     fclose(fp);
     remove("/local/out.txt");                 // Removes the file "out.txt" from the local file system

     DIR *d = opendir("/local");               // Opens the root directory of the local file system
     struct dirent *p;
     while((p = readdir(d)) != NULL) {         // Print the names of the files in the local file system
       printf("%s\n", p->d_name);              // to stdout.
     }
     closedir(d);
 }

Note:: If the microcontroller program makes an access to the local drive, it will be marked as "removed" on the Host computer. This means it is no longer accessible from the Host Computer.

The drive will only re-appear when the microcontroller program exists. Note that if the program does not exit, you will need to hold down reset on the mbed Microcontroller to be able to see the drive again!

Definition at line 106 of file cmsis/BUILD/mbed/platform/LocalFileSystem.h.

Member Function Documentation

MBED_DEPRECATED ( "Invalid copy construction of a NonCopyable< FileSystemHandle > resource." ) const [protected, inherited]

NonCopyable copy constructor.