Rtos API example
FileSystemLike Class Reference
[FileSystemLike functions]
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 FileSystem, and 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. | |
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. | |
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-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 43 of file FileSystemLike.h.
Constructor & Destructor Documentation
FileSystemLike | ( | const char * | name = NULL ) |
FileSystemLike lifetime.
Definition at line 47 of file FileSystemLike.h.
Member Function Documentation
MBED_DEPRECATED | ( | "Invalid copy construction of a NonCopyable< FileBase > resource." | ) | const [protected, inherited] |
NonCopyable copy constructor.
A compile time warning is issued when this function is used and a runtime warning is printed when the copy construction of the non copyable happens.
If you see this warning, your code is probably doing something unspecified. Copy of non copyable resources can lead to resource leak and random error.
Definition at line 171 of file NonCopyable.h.
MBED_DEPRECATED | ( | "Invalid copy assignment of a NonCopyable< FileBase > resource." | ) | [protected, inherited] |
NonCopyable copy assignment operator.
A compile time warning is issued when this function is used and a runtime warning is printed when the copy construction of the non copyable happens.
If you see this warning, your code is probably doing something unspecified. Copy of non copyable resources can lead to resource leak and random error.
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.5" | , |
"Replaced by `int open(FileHandle **, ...)` for propagating error codes" | |||
) | const |
Open a file on the filesystem.
- Parameters:
-
path 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:
- A file handle on success, NULL on failure
virtual int mkdir | ( | const char * | path, |
mode_t | mode | ||
) | [virtual, inherited] |
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 FATFileSystem, and FileSystem.
virtual int open | ( | FileHandle ** | file, |
const char * | filename, | ||
int | flags | ||
) | [pure virtual, inherited] |
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 FileSystem, and LocalFileSystem.
virtual int open | ( | DirHandle ** | dir, |
const char * | path | ||
) | [virtual, inherited] |
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 FileSystem, and LocalFileSystem.
virtual int remove | ( | const char * | path ) | [virtual, inherited] |
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 FATFileSystem, FileSystem, and LocalFileSystem.
virtual int rename | ( | const char * | path, |
const char * | newpath | ||
) | [virtual, inherited] |
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 FATFileSystem, and FileSystem.
virtual int stat | ( | const char * | path, |
struct stat * | st | ||
) | [virtual, inherited] |
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 FATFileSystem, and FileSystem.
Generated on Sun Jul 17 2022 08:25:44 by 1.7.2