Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Public Attributes | Friends | List of all members
AZ::IO::PathIterator< PathType > Class Template Reference

#include <Path.h>

Public Types

enum  ParserState : uint8_t {
  Singular , BeforeBegin , InRootName , InRootDir ,
  InFilenames , AtEnd
}
 
using iterator_category = AZStd::bidirectional_iterator_tag
 
using value_type = AZStd::remove_cv_t< PathType >
 
using difference_type = ptrdiff_t
 
using pointer = const value_type *
 
using reference = const value_type &
 
using stashing_iterator_tag = void
 

Public Member Functions

constexpr PathIterator (const PathIterator &)=default
 
constexpr PathIterator (PathIterator &&) noexcept=default
 
constexpr PathIterator & operator= (const PathIterator &)=default
 
constexpr PathIterator & operator= (PathIterator &&) noexcept=default
 
constexpr reference operator* () const
 
constexpr pointer operator-> () const
 
constexpr PathIterator & operator++ ()
 
constexpr PathIterator operator++ (int)
 
constexpr PathIterator & operator-- ()
 
constexpr PathIterator operator-- (int)
 

Public Attributes

friend PathType
 

Friends

template<typename PathType1 >
constexpr bool operator== (const PathIterator< PathType1 > &lhs, const PathIterator< PathType1 > &rhs)
 
template<typename PathType1 >
constexpr bool operator!= (const PathIterator< PathType1 > &lhs, const PathIterator< PathType1 > &rhs)
 

Detailed Description

template<typename PathType>
class AZ::IO::PathIterator< PathType >

Path iterator that allows traversal of the path elements Example iterations of path can be seen in the PathIteratorFixture in the PathTests. For example the following path with a R"(\\server\share\users\abcdef\AppData\Local\Temp)", with a path separator of '\', Iterates the following elements {R"(\\server)", R"(\‍)", "share", "users", "abcdef", "AppData", "Local", "Temp"} },

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