C/C++ User's Journal STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - where the Standard Template Library meets the Active Template Library COMSTL - where the Standard Template Library meets the Component Object Model
Synesis Software InetSTL - where the Standard Template Library meets the Internet UNIXSTL - Template Software for the UNIX Operating System WinSTL - where the Standard Template Library meets the Win32 API

Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

basic_search_sequence Class Template Reference
[recls.stl]

Presents an STL-like sequence interface over the items on the file-system. More...

#include <search_sequence.hpp>

List of all members.

State

size_type size () const
 Returns the number of items in the sequence.

recls_bool_t empty () const
 Indicates whether the sequence is empty.

size_type max_size ()
 Returns the maximum number of items in the sequence.


Public Types

Types
typedef C char_type
 The character type.

typedef T traits_type
 The traits type.

typedef basic_search_sequence<
C, T > 
class_type
 The current parameterisation of the type.

typedef basic_search_sequence_value_type<
C, T > 
value_type
 The value type.

typedef basic_search_sequence_const_iterator<
C, T, value_type
const_iterator
 The non-mutating (const) iterator type supporting the Input Iterator concept.

typedef value_typereference
 The reference type.

typedef value_type const & const_reference
 The non-mutable (const) reference type.

typedef ss_typename_type_k
traits_type::entry_type 
entry_type
 The find-data type.

typedef size_t size_type
 The size type.

typedef ptrdiff_t difference_type
 The difference type.

typedef stlsoft::basic_simple_string<
C > 
string_type
 The string type.


Public Methods

Construction
 basic_search_sequence (char_type const *pattern, recls_uint32_t flags)
 Commence a search according to the given search pattern and flags.

 basic_search_sequence (char_type const *directory, char_type const *pattern, recls_uint32_t flags)
 Commence a search according to the given search pattern and flags, relative to directory.

 ~basic_search_sequence ()
 Destructor.

Iteration
const_iterator begin () const
 Begins the iteration.

const_iterator end () const
 Ends the iteration.


Detailed Description

template<typename C, typename T>
class recls::stl::basic_search_sequence< C, T >

Presents an STL-like sequence interface over the items on the file-system.

Parameters:
C  The character type
T  The traits type. On translators that support default template arguments this defaults to reclstl_traits<C>


Member Typedef Documentation

typedef C char_type
 

The character type.

typedef basic_search_sequence<C, T> class_type
 

The current parameterisation of the type.

typedef basic_search_sequence_const_iterator<C, T, value_type> const_iterator
 

The non-mutating (const) iterator type supporting the Input Iterator concept.

typedef value_type const& const_reference
 

The non-mutable (const) reference type.

typedef ptrdiff_t difference_type
 

The difference type.

typedef ss_typename_type_k traits_type::entry_type entry_type
 

The find-data type.

typedef value_type& reference
 

The reference type.

typedef size_t size_type
 

The size type.

typedef stlsoft::basic_simple_string<C> string_type
 

The string type.

typedef T traits_type
 

The traits type.

typedef basic_search_sequence_value_type<C, T> value_type
 

The value type.


Constructor & Destructor Documentation

basic_search_sequence char_type const *    pattern,
recls_uint32_t    flags
 

Commence a search according to the given search pattern and flags.

basic_search_sequence char_type const *    directory,
char_type const *    pattern,
recls_uint32_t    flags
 

Commence a search according to the given search pattern and flags, relative to directory.

~basic_search_sequence   [inline]
 

Destructor.


Member Function Documentation

const_iterator begin  
 

Begins the iteration.

Returns:
An iterator representing the start of the sequence

recls_bool_t empty  
 

Indicates whether the sequence is empty.

const_iterator end  
 

Ends the iteration.

Returns:
An iterator representing the end of the sequence

size_type max_size   [static]
 

Returns the maximum number of items in the sequence.

size_type size  
 

Returns the number of items in the sequence.


Friends And Related Function Documentation

friend class basic_search_sequence_const_iterator< C, T, value_type > [friend]
 

friend class basic_search_sequence_value_type< C, T > [friend]
 


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

recls Library documentation Synesis Software Pty Ltd, 2001-2005