forked

Embed: (wiki syntax)

« Back to documentation index

FileSystemLike Class Reference

FileSystemLike Class Reference
[Platform]

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

#include <FileSystemLike.h>

Inherits mbed::FileSystemHandle, mbed::FileBase, and NonCopyable< FileSystemLike >.

Inherited by LocalFileSystem.

Public Member Functions

 FileSystemLike (const char *name=NULL)
 FileSystemLike lifetime.
 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 open (FileHandle **file, const char *filename, int flags)=0
 Open a file on the filesystem.
virtual int open (DirHandle **dir, const char *path)
 Open a directory on the filesystem.
virtual int remove (const char *path)
 Remove a file from 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 mkdir (const char *path, mode_t mode)
 Create a directory in the filesystem.

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

Definition at line 39 of file FileSystemLike.h.


Constructor & Destructor Documentation

FileSystemLike ( const char *  name = NULL )

FileSystemLike lifetime.

Definition at line 43 of file FileSystemLike.h.


Member Function Documentation

MBED_DEPRECATED_SINCE ( "mbed-os-5.5"  ,
"Replaced by `int open(FileHandle **, ...)` for propagating error codes"   
) const

Open a file on the filesystem.

Parameters:
pathThe name of the file to open
flagsThe 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:
A file handle on success, NULL on failure