sshpp::sftp::Directory Class Reference

An open SFTP directory handle. See docs/design/06 §6.4. More...

#include <directory.hpp>

Public Member Functions
	Directory ()=default
	~Directory ()
	Directory (Directory &&) noexcept
Directory &	operator= (Directory &&) noexcept
	Directory (const Directory &)=delete
	operator bool () const noexcept
const RemotePath &	path () const noexcept
std::optional< Attributes >	next ()
	nullopt when exhausted. Errors are reported through last_error().
bool	eof () const noexcept
const ErrorInfo &	last_error () const noexcept

Friends
class	Sftp

Detailed Description

An open SFTP directory handle. See docs/design/06 §6.4.

Constructor & Destructor Documentation

Directory() [1/3]

sshpp::sftp::Directory::Directory ( )

default

~Directory()

SSHPP_INLINE sshpp::sftp::Directory::~Directory

(

)

Directory() [2/3]

SSHPP_INLINE sshpp::sftp::Directory::Directory ( Directory &&  other )

noexcept

Directory() [3/3]

sshpp::sftp::Directory::Directory ( const Directory &  )

delete

Member Function Documentation

operator=()

SSHPP_INLINE Directory & sshpp::sftp::Directory::operator= ( Directory &&  other )

noexcept

operator bool()

sshpp::sftp::Directory::operator bool ( ) const

inlineexplicitnoexcept

path()

const RemotePath & sshpp::sftp::Directory::path ( ) const

inlinenoexcept

next()

SSHPP_INLINE std::optional< Attributes > sshpp::sftp::Directory::next

(

)

nullopt when exhausted. Errors are reported through last_error().

eof()

SSHPP_INLINE bool sshpp::sftp::Directory::eof ( ) const

noexcept

last_error()

const ErrorInfo & sshpp::sftp::Directory::last_error ( ) const

inlinenoexcept

Friends And Related Symbol Documentation

Sftp

friend class Sftp

friend

---

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

• include/sshpp/sftp/directory.hpp
• include/sshpp/detail/directory.ipp