ecl::fs::dir_descriptor Class Reference

Directory descriptor interface. More...

#include </home/travis/build/forGGe/theCore/lib/fs/export/ecl/fs/dir_descriptor.hpp>

Inheritance diagram for ecl::fs::dir_descriptor:

Collaboration diagram for ecl::fs::dir_descriptor:

Public Member Functions
	dir_descriptor (const inode_weak &node)
	Constructs and opens directory descriptor from corresponding inode. More...
virtual	~dir_descriptor ()
	Closes and destructs dir descriptor. More...
virtual inode_ptr	read ()=0
	Advances to the next item in the directory and gets current entity. More...
virtual ecl::err	rewind ()=0
	Rewindes to the start of the directory. More...
virtual ecl::err	close ()=0
	Closes a descriptor. More...

Protected Attributes
inode_ptr	m_inode
	Associated inode. More...

Detailed Description

Directory descriptor interface.

Constructor & Destructor Documentation

dir_descriptor()

dir_descriptor::dir_descriptor

(

const inode_weak &

node

)

Constructs and opens directory descriptor from corresponding inode.

Here is the call graph for this function:

~dir_descriptor()

dir_descriptor::~dir_descriptor ( )

virtual

Closes and destructs dir descriptor.

Member Function Documentation

read()

virtual inode_ptr ecl::fs::dir_descriptor::read ( )

pure virtual

Advances to the next item in the directory and gets current entity.

The entity could be a directory or a file from current directory, represented by this directory descriptor.

Precondition

Opened descriptor.

Returns

Next item in the directory, or nullptr if no more items.

Implemented in ecl::fat::dir.

rewind()

virtual ecl::err ecl::fs::dir_descriptor::rewind ( )

pure virtual

Rewindes to the start of the directory.

Precondition

Opened descriptor.

Return values

Status

of operation.

Implemented in ecl::fat::dir.

close()

virtual ecl::err ecl::fs::dir_descriptor::close ( )

pure virtual

Closes a descriptor.

Precondition

Opened descriptor.

Return values

Status

of operation.

Implemented in ecl::fat::dir.

Field Documentation

m_inode

inode_ptr ecl::fs::dir_descriptor::m_inode

protected

Associated inode.

---

The documentation for this class was generated from the following files:

• dir_descriptor.hpp
• dir_descriptor.cpp