sshpp::sftp::DirectoryIterator Class Reference

InputIterator over a Directory. Skips "." and ".." by default. More...

#include <directory.hpp>

Public Types
using	value_type = Attributes
using	difference_type = std::ptrdiff_t
using	pointer = const Attributes *
using	reference = const Attributes &
using	iterator_category = std::input_iterator_tag

Public Member Functions
	DirectoryIterator ()=default
	DirectoryIterator (Directory &dir, bool skip_dot_entries=true)
const Attributes &	operator* () const
const Attributes *	operator-> () const
DirectoryIterator &	operator++ ()
bool	operator== (const DirectoryIterator &other) const noexcept
bool	operator!= (const DirectoryIterator &other) const noexcept

Detailed Description

InputIterator over a Directory. Skips "." and ".." by default.

Member Typedef Documentation

value_type

using sshpp::sftp::DirectoryIterator::value_type = Attributes

difference_type

using sshpp::sftp::DirectoryIterator::difference_type = std::ptrdiff_t

pointer

using sshpp::sftp::DirectoryIterator::pointer = const Attributes*

reference

using sshpp::sftp::DirectoryIterator::reference = const Attributes&

iterator_category

using sshpp::sftp::DirectoryIterator::iterator_category = std::input_iterator_tag

Constructor & Destructor Documentation

DirectoryIterator() [1/2]

sshpp::sftp::DirectoryIterator::DirectoryIterator ( )

default

DirectoryIterator() [2/2]

sshpp::sftp::DirectoryIterator::DirectoryIterator ( Directory &  dir, bool  skip_dot_entries = true  )

inlineexplicit

Member Function Documentation

operator*()

const Attributes & sshpp::sftp::DirectoryIterator::operator* ( ) const

inline

operator->()

const Attributes * sshpp::sftp::DirectoryIterator::operator-> ( ) const

inline

operator++()

DirectoryIterator & sshpp::sftp::DirectoryIterator::operator++ ( )

inline

operator==()

bool sshpp::sftp::DirectoryIterator::operator== ( const DirectoryIterator &  other ) const

inlinenoexcept

operator!=()

bool sshpp::sftp::DirectoryIterator::operator!= ( const DirectoryIterator &  other ) const

inlinenoexcept

---

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

• include/sshpp/sftp/directory.hpp