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>

Inheritance diagram for FileSystemLike:

Public Member Functions
	FileSystemLike (const char *name=NULL)
	FileSystemLike lifetime. More...

FileHandle *	open (const char *path, int flags)
	Open a file on the filesystem. More...

DirHandle *	opendir (const char *path)
	Open a directory on the filesystem. More...

virtual int	open (FileHandle *file, const char filename, int flags)=0
	Open a file on the filesystem. More...

virtual int	open (DirHandle *dir, const char path)
	Open a directory on the filesystem. More...

virtual int	remove (const char *path)
	Remove a file from the filesystem. More...

virtual int	rename (const char path, const char newpath)
	Rename a file in the filesystem. More...

virtual int	stat (const char path, struct stat st)
	Store information about the file in a stat structure. More...

virtual int	mkdir (const char *path, mode_t mode)
	Create a directory in the filesystem. More...

virtual int	statvfs (const char path, struct statvfs buf)
	Store information about the mounted filesystem in a statvfs structure. More...

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

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

virtualinherited

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

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

pure virtualinherited

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.

FileHandle* open	(	const char *	path,
		int	flags
	)

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

Deprecated:: Replaced by int open(FileHandle **, ...) for propagating error codes

Definition at line 64 of file FileSystemLike.h.

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

virtualinherited

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.

DirHandle* opendir ( const char * path )

Open a directory on the filesystem.

Parameters

path	Name of the directory to open

Returns: A directory handle on success, NULL on failure

Deprecated:: Replaced by int open(DirHandle **, ...) for propagating error codes

Definition at line 79 of file FileSystemLike.h.

virtual int remove ( const char * path )

virtualinherited

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

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

virtualinherited

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

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

virtualinherited

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

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

virtualinherited

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Important Information for this Arm website