Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
Dir Class Reference

Dir class. More...

#include <Dir.h>

Inheritance diagram for Dir:
DirHandle NonCopyable< DirHandle >

Public Member Functions

 Dir ()
 Create an uninitialized directory. More...
 
 Dir (FileSystem *fs, const char *path)
 Open a directory on a filesystem. More...
 
virtual ~Dir ()
 Destroy a file. More...
 
virtual int open (FileSystem *fs, const char *path)
 Open a directory on the filesystem. More...
 
virtual int close ()
 Close a directory. More...
 
virtual ssize_t read (struct dirent *ent)
 Read the next directory entry. More...
 
virtual void seek (off_t offset)
 Set the current position of the directory. More...
 
virtual off_t tell ()
 Get the current position of the directory. More...
 
virtual void rewind ()
 Rewind the current position to the beginning of the directory. More...
 
virtual size_t size ()
 Get the sizeof the directory. More...
 

Detailed Description

Dir class.

Definition at line 30 of file Dir.h.

Constructor & Destructor Documentation

Dir ( )

Create an uninitialized directory.

Must call open to initialize the directory on a file system

Dir ( FileSystem fs,
const char *  path 
)

Open a directory on a filesystem.

Parameters
fsFilesystem as target for a directory
pathName of the directory to open
virtual ~Dir ( )
virtual

Destroy a file.

Closes file if the file is still open

Member Function Documentation

virtual int close ( )
virtual

Close a directory.

Returns
0 on success, negative error code on failure

Implements DirHandle.

virtual int open ( FileSystem fs,
const char *  path 
)
virtual

Open a directory on the filesystem.

Parameters
fsFilesystem as target for a directory
pathName of the directory to open
Returns
0 on success, negative error code on failure
virtual ssize_t read ( struct dirent ent)
virtual

Read the next directory entry.

Parameters
entThe directory entry to fill out
Returns
1 on reading a filename, 0 at end of directory, negative error on failure

Implements DirHandle.

virtual void rewind ( )
virtual

Rewind the current position to the beginning of the directory.

Implements DirHandle.

virtual void seek ( off_t  offset)
virtual

Set the current position of the directory.

Parameters
offsetOffset of the location to seek to, must be a value returned from tell

Implements DirHandle.

virtual size_t size ( )
virtual

Get the sizeof the directory.

Returns
Number of files in the directory

Reimplemented from DirHandle.

virtual off_t tell ( )
virtual

Get the current position of the directory.

Returns
Position of the directory that can be passed to rewind

Implements DirHandle.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.