Represents a directory stream. More...

#include <DirHandle.h>

Inheritance diagram for DirHandle:

Public Member Functions
virtual ssize_t	read (struct dirent *ent)=0
	Read the next directory entry. More...

virtual int	close ()=0
	Close a directory. More...

virtual void	seek (off_t offset)=0
	Set the current position of the directory. More...

virtual off_t	tell ()=0
	Get the current position of the directory. More...

virtual void	rewind ()=0
	Rewind the current position to the beginning of the directory. More...

virtual size_t	size ()
	Get the sizeof the directory. More...

virtual int	closedir ()
	Closes the directory. More...

virtual struct dirent *	readdir ()
	Returns the directory entry at the current position, and advances the position to the next entry. More...

virtual void	rewinddir ()
	Resets the position to the beginning of the directory. More...

virtual off_t	telldir ()
	Returns the current position of the DirHandle. More...

virtual void	seekdir (off_t location)
	Sets the position of the DirHandle. More...

Detailed Description

Represents a directory stream.

An opendir function returns objects of this type. The core functions are read and seek, but only a subset needs to be provided.

If a FileSystemLike class defines the opendir method, then you can access the directories of an object of that type by either:

DIR *d = opendir("/example/directory");

or

DIR *d = opendir("/example");

to open the root of the file system.

The root directory is considered to contain all FileHandle and FileSystem objects, so the DIR pointer returned by opendir("/") reflects this.

Note: to create a directory,

See also: Dir

Note: Synchronization level: Set by subclass

Definition at line 56 of file DirHandle.h.

Member Function Documentation

virtual int close ( )

pure virtual

Close a directory.

Returns: 0 on success, negative error code on failure

Implemented in Dir.

virtual int closedir ( )

virtual

Closes the directory.

Returns: 0 on success, -1 on error.

Deprecated:: Replaced by `int DirHandle::close()'

Definition at line 118 of file DirHandle.h.

virtual ssize_t read ( struct dirent * ent )

pure virtual

Read the next directory entry.

Parameters

ent	The directory entry to fill out

Returns: 1 on reading a filename, 0 at end of directory, negative error on failure

Implemented in Dir.

virtual struct dirent* readdir ( )

virtual

Returns the directory entry at the current position, and advances the position to the next entry.

Returns: A pointer to a dirent structure representing the directory entry at the current position, or NULL on reaching end of directory or error.

Deprecated:: Replaced by `ssize_t DirHandle::read(struct dirent *ent)

Definition at line 133 of file DirHandle.h.

virtual void rewind ( )

pure virtual

Rewind the current position to the beginning of the directory.

Implemented in Dir.

virtual void rewinddir ( )

virtual

Resets the position to the beginning of the directory.

Deprecated:: Replaced by `void DirHandle::rewind()'

Definition at line 143 of file DirHandle.h.

virtual void seek ( off_t offset )

pure virtual

Set the current position of the directory.

Parameters

offset Offset of the location to seek to, must be a value returned from tell

Implemented in Dir.

virtual void seekdir ( off_t location )

virtual

Sets the position of the DirHandle.

Parameters

location The location to seek to. Must be a value returned by telldir.

Deprecated:: Replaced by `void DirHandle::seek(off_t offset)'

Definition at line 167 of file DirHandle.h.

virtual size_t size ( )

virtual

Get the sizeof the directory.

Returns: Number of files in the directory

Reimplemented in Dir.

Definition at line 94 of file DirHandle.h.

virtual off_t tell ( )

pure virtual

Get the current position of the directory.

Returns: Position of the directory that can be passed to rewind

Implemented in Dir.

virtual off_t telldir ( )

virtual

Returns the current position of the DirHandle.

Returns: the current position, -1 on error.

Deprecated:: Replaced by `off_t DirHandle::tell()'

Definition at line 156 of file DirHandle.h.

Public Member Functions

Detailed Description

Member Function Documentation

Important Information for this Arm website