Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

FileSystemLike Class Reference
Public Member Functions | Protected Member Functions | Private Member Functions

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.
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.

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 44 of file FileSystemLike.h.

Constructor & Destructor Documentation

FileSystemLike ( const char *  name = NULL )

FileSystemLike lifetime.

Definition at line 48 of file FileSystemLike.h.

Member Function Documentation

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 noncopyable happens.

If you see this warning, your code is probably doing something unspecified. Copying of noncopyable resources can lead to resource leak and random error.

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 noncopyable happens.

If you see this warning, your code is probably doing something unspecified. Copying of noncopyable resources can lead to resource leak and random error.

Definition at line 191 of file NonCopyable.h.

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
int mkdir ( const char *  path,
mode_t  mode 
) [virtual, inherited]

Create a directory in the filesystem.

Parameters:
pathThe name of the directory to create.
modeThe permissions with which to create the directory
Returns:
0 on success, negative error code on failure

Reimplemented in FATFileSystem, FileSystem, and LittleFileSystem.

Definition at line 42 of file FileSystemHandle.cpp.

virtual int open ( FileHandle **  file,
const char *  filename,
int  flags 
) [pure virtual, inherited]

Open a file on the filesystem.

Parameters:
fileDestination for the handle to a newly created file
filenameThe 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:
0 on success, negative error code on failure

Implemented in FileSystem, and LocalFileSystem.

int open ( mbed::DirHandle **  dir,
const char *  path 
) [virtual, inherited]

Open a directory on the filesystem.

Parameters:
dirDestination for the handle to the directory
pathName of the directory to open
Returns:
0 on success, negative error code on failure

Reimplemented in FileSystem, and LocalFileSystem.

Definition at line 22 of file FileSystemHandle.cpp.

int remove ( const char *  path ) [virtual, inherited]

Remove a file from the filesystem.

Parameters:
pathThe name of the file to remove.
Returns:
0 on success, negative error code on failure

Reimplemented in FATFileSystem, FileSystem, LittleFileSystem, and LocalFileSystem.

Definition at line 27 of file FileSystemHandle.cpp.

int rename ( const char *  path,
const char *  newpath 
) [virtual, inherited]

Rename a file in the filesystem.

Parameters:
pathThe name of the file to rename.
newpathThe name to rename it to
Returns:
0 on success, negative error code on failure

Reimplemented in FATFileSystem, FileSystem, and LittleFileSystem.

Definition at line 32 of file FileSystemHandle.cpp.

int stat ( const char *  path,
struct stat *  st 
) [virtual, inherited]

Store information about the file in a stat structure.

Parameters:
pathThe name of the file to find information about
stThe stat buffer to write to
Returns:
0 on success, negative error code on failure

Reimplemented in FATFileSystem, FileSystem, and LittleFileSystem.

Definition at line 37 of file FileSystemHandle.cpp.

int statvfs ( const char *  path,
struct statvfs *  buf 
) [virtual, inherited]

Store information about the mounted filesystem in a statvfs structure.

Parameters:
pathThe name of the file to find information about
bufThe stat buffer to write to
Returns:
0 on success, negative error code on failure

Reimplemented in FATFileSystem, FileSystem, and LittleFileSystem.

Definition at line 47 of file FileSystemHandle.cpp.

Generated on Tue Jul 12 2022 13:55:44 by  doxygen 1.7.2