readdir_sequence::const_iterator Class Reference
[File System Library]

#include <unixstl/filesystem/readdir_sequence.hpp>

Inheritance diagram for readdir_sequence::const_iterator:

iterator_base< unixstl_ns_qual_std(input_iterator_tag), readdir_sequence::value_type, us_ptrdiff_t, void, readdir_sequence::value_type >

List of all members.


Detailed Description

Iterator for the readdir_sequence class.

This class performs as a non-mutating iterator (aka const iterator) for the readdir_sequence class.

Members

typedef const_iterator class_type
 The class type.
typedef
readdir_sequence::value_type 
value_type
 The value type.
typedef
readdir_sequence::flags_type 
flags_type
 The flags type.

Construction

 const_iterator ()
 Default constructor.
 const_iterator (class_type const &rhs)
 Copy constructor.
 ~const_iterator () throw ()
 Release the search handle.
class_type const & operator= (class_type const &rhs)
 Copy assignment operator.

Public Member Functions

Input Iterator Methods
value_type operator* () const
 Returns the value representative.
class_typeoperator++ ()
 Moves the iteration on to the next point in the sequence, or end() if the sequence is exhausted.
class_type operator++ (int)
 Post-increment form of operator ++().
bool equal (class_type const &rhs) const
 Compares this for equality with rhs.


Member Typedef Documentation

The class type.

The flags type.


Constructor & Destructor Documentation

const_iterator (  ) 

Default constructor.

const_iterator ( class_type const &  rhs  ) 

Copy constructor.

~const_iterator (  )  throw ()

Release the search handle.


Member Function Documentation

class_type const& operator= ( class_type const &  rhs  ) 

Copy assignment operator.

value_type operator* (  )  const

Returns the value representative.

class_type& operator++ (  ) 

Moves the iteration on to the next point in the sequence, or end() if the sequence is exhausted.

class_type operator++ ( int   ) 

Post-increment form of operator ++().

Note:
Because this version uses a temporary on which to call the pre-increment form it is thereby less efficient, and should not be used except where post-increment semantics are required.

bool equal ( class_type const &  rhs  )  const

Compares this for equality with rhs.

Parameters:
rhs The instance against which to test
Return values:
true if the iterators are equivalent
false if the iterators are not equivalent


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

Generated on Thu Jun 10 08:59:08 2010 for STLSoft by  doxygen 1.5.6