cosmos::Directory Class Reference

Representation of open directory file descriptors. More...

#include <Directory.hxx>

Public Member Functions
	Directory (DirFD fd, const AutoCloseFD auto_close)
	Directory (const SysString path, const OpenMode mode=OpenMode::READ_ONLY)
	Open a directory by path without special flags (close-on-exec will be set).
	Directory (const SysString path, const OpenMode mode, const OpenFlags flags)
	Open a directory by path using the given mode and flags.
	Directory (const DirFD dir_fd, const SysString path, const OpenMode mode=OpenMode::READ_ONLY)
	Open a directory by path relative to dir_fd using the given mode and default flags.
	Directory (const DirFD dir_fd, const SysString path, const OpenMode mode, const OpenFlags flags)
	Open a directory by path relative to dir_fd using the given mode and flags.
	Directory (const Directory &)=delete
Directory &	operator= (const Directory &)=delete
	Directory (Directory &&other) noexcept
Directory &	operator= (Directory &&other) noexcept
void	open (const SysString path, const OpenMode mode=OpenMode::READ_ONLY)
	Open a directory by path without special flags (close-on-exec will be set).
void	open (const SysString path, const OpenMode mode, OpenFlags flags)
	Open a directory by path using the given mode and flags.
void	open (const DirFD dir_fd, const SysString path, const OpenMode mode)
	Open a directory by path relative to dir_fd using the given mode and default flags.
void	open (const DirFD dir_fd, const SysString path, const OpenMode mode, const OpenFlags flags)
	Open a directory by path relative to dir_fd using the given mode and flags.
void	open (DirFD fd, const AutoCloseFD auto_close)
	Takes the already open directory file descriptor fd and operators on it.
bool	isOpen () const
void	close ()
	Close the current dir object.
DirFD	fd () const
void	unlinkFileAt (const SysString path) const
void	makeDirAt (const SysString path, const FileMode mode) const
void	removeDirAt (const SysString path) const
std::string	readSymlinkAt (const SysString path) const
void	makeSymlinkAt (const SysString target, const SysString path) const

Protected Attributes
AutoCloseFD	m_auto_close
DirFD	m_fd

Detailed Description

Representation of open directory file descriptors.

This is similar to the File class but dedicated to opening Directory nodes. This class is not intended for access directory contents, use DirStream for this instead.

This type mainly exists to express situations when only directory file descriptors are acceptable, like in the context of the various openat like APIs.

Definition at line 20 of file Directory.hxx.

Constructor & Destructor Documentation

Directory() [1/6]

cosmos::Directory::Directory ( DirFD fd, const AutoCloseFD auto_close )

inlineexplicit

Definition at line 25 of file Directory.hxx.

                                                                   {
                open(fd, auto_close);
        }

Directory() [2/6]

cosmos::Directory::Directory ( const SysString path, const OpenMode mode = OpenMode::READ_ONLY )

inlineexplicit

Open a directory by path without special flags (close-on-exec will be set).

Definition at line 31 of file Directory.hxx.

                                                                                          :
                        Directory{path, mode, {OpenFlag::CLOEXEC}} {}

Directory() [3/6]

cosmos::Directory::Directory ( const SysString path, const OpenMode mode, const OpenFlags flags )

inlineexplicit

Open a directory by path using the given mode and flags.

See also

open(const std::SysString, const OpenMode, const OpenFlags)

Definition at line 38 of file Directory.hxx.

                                                                                             {
                open(path, mode, flags);
        }

Directory() [4/6]

cosmos::Directory::Directory ( const DirFD dir_fd, const SysString path, const OpenMode mode = OpenMode::READ_ONLY )

inline

Open a directory by path relative to dir_fd using the given mode and default flags.

Definition at line 43 of file Directory.hxx.

                                                                                                     :
                        Directory{dir_fd, path, mode, {OpenFlag::CLOEXEC}} {}

Directory() [5/6]

cosmos::Directory::Directory ( const DirFD dir_fd, const SysString path, const OpenMode mode, const OpenFlags flags )

inline

Open a directory by path relative to dir_fd using the given mode and flags.

Definition at line 47 of file Directory.hxx.

                                               {
                open(dir_fd, path, mode, flags);
        }

Directory() [6/6]

cosmos::Directory::Directory ( Directory && other )

inlinenoexcept

Definition at line 56 of file Directory.hxx.

                                              {
                *this = std::move(other);
        }

~Directory()

cosmos::Directory::~Directory ( )

virtual

Definition at line 10 of file Directory.cxx.

                      {
        const auto orig_fd = m_fd.raw();
        try {
                this->close();
        } catch (const std::exception &e) {
                noncritical_error(sprintf("%s: failed to close fd(%d)", __FUNCTION__, to_integral(orig_fd)), e);
        }
}

Member Function Documentation

close()

void cosmos::Directory::close ( )

inline

Close the current dir object.

If currently no dir is open then this does nothing. If currently an external DirFD is wrapped and auto-close is not set then only the object's state will be invalidated. Otherwise the referenced file descriptor will also be closed on OS-level.

Definition at line 117 of file Directory.hxx.

                     {
                if (!isOpen())
                        return;
 
                if (m_auto_close) {
                        m_fd.close();
                } else {
                        m_fd.reset();
                }
 
                m_auto_close = AutoCloseFD{true};
        }

fd()

DirFD cosmos::Directory::fd ( ) const

inline

Definition at line 130 of file Directory.hxx.

{ return m_fd; }

isOpen()

bool cosmos::Directory::isOpen ( ) const

inline

Definition at line 108 of file Directory.hxx.

{ return m_fd.valid(); }

makeDirAt()

void cosmos::Directory::makeDirAt ( const SysString path, const FileMode mode ) const

inline

Definition at line 164 of file Directory.hxx.

                                                                         {
        fs::make_dir_at(m_fd, path, mode);
}

makeSymlinkAt()

void cosmos::Directory::makeSymlinkAt ( const SysString target, const SysString path ) const

inline

Definition at line 176 of file Directory.hxx.

                                                                                {
        fs::make_symlink_at(target, m_fd, path);
}

open() [1/5]

void cosmos::Directory::open ( const DirFD dir_fd, const SysString path, const OpenMode mode )

inline

Open a directory by path relative to dir_fd using the given mode and default flags.

Definition at line 85 of file Directory.hxx.

                                                                                 {
                open(dir_fd, path, mode, {OpenFlag::CLOEXEC});
        }

open() [2/5]

void cosmos::Directory::open	(	const DirFD	dir_fd,
		const SysString	path,
		const OpenMode	mode,
		const OpenFlags	flags )

Open a directory by path relative to dir_fd using the given mode and flags.

Definition at line 27 of file Directory.cxx.

                                                                                                   {
        m_auto_close = AutoCloseFD{true};
        flags.set(OpenFlag::DIRECTORY);
 
        auto fd = fs::open_at(dir_fd, path, mode, flags, {});
        m_fd = DirFD{fd.raw()};
}

open() [3/5]

void cosmos::Directory::open	(	const SysString	path,
		const OpenMode	mode,
		OpenFlags	flags )

Open a directory by path using the given mode and flags.

The OpenFlag::DIRECTORY flag will implicitly be set in flags, since this is required to ensure that the resulting file descriptor will refer to a directory.

Definition at line 19 of file Directory.cxx.

                                                                               {
 
        m_auto_close = AutoCloseFD{true};
        flags.set(OpenFlag::DIRECTORY);
        auto fd = fs::open(path, mode, flags, {});
        m_fd = DirFD{fd.raw()};
}

open() [4/5]

void cosmos::Directory::open ( const SysString path, const OpenMode mode = OpenMode::READ_ONLY )

inline

Open a directory by path without special flags (close-on-exec will be set).

Definition at line 72 of file Directory.hxx.

                                                                                 {
                return open(path, mode, {OpenFlag::CLOEXEC});
        }

open() [5/5]

void cosmos::Directory::open ( DirFD fd, const AutoCloseFD auto_close )

inline

Takes the already open directory file descriptor fd and operators on it.

The caller is responsible for invalidating fd, if desired, and that the file descriptor is not used in conflicting ways.

The parameter auto_close determines whether the File object will take ownership of the file descriptor, or not. If so then the file descriptor is closed on OS level if deemed necessary by the implementation.

Definition at line 103 of file Directory.hxx.

                                                          {
                m_fd = fd;
                m_auto_close = auto_close;
        }

operator=()

Directory & cosmos::Directory::operator= ( Directory && other )

inlinenoexcept

Definition at line 60 of file Directory.hxx.

                                                         {
                m_auto_close = other.m_auto_close;
                m_fd = other.m_fd;
 
                other.m_auto_close = AutoCloseFD{true};
                other.m_fd.reset();
                return *this;
        }

readSymlinkAt()

std::string cosmos::Directory::readSymlinkAt ( const SysString path ) const

inline

Definition at line 172 of file Directory.hxx.

                                                             {
        return fs::read_symlink_at(m_fd, path);
}

removeDirAt()

void cosmos::Directory::removeDirAt ( const SysString path ) const

inline

Definition at line 168 of file Directory.hxx.

                                                      {
        fs::remove_dir_at(m_fd, path);
}

unlinkFileAt()

void cosmos::Directory::unlinkFileAt ( const SysString path ) const

inline

Definition at line 160 of file Directory.hxx.

                                                       {
        fs::unlink_file_at(m_fd, path);
}

Member Data Documentation

m_auto_close

AutoCloseFD cosmos::Directory::m_auto_close

protected

Definition at line 149 of file Directory.hxx.

m_fd

DirFD cosmos::Directory::m_fd

protected

Definition at line 150 of file Directory.hxx.

---

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

• include/fs/Directory.hxx
• src/fs/Directory.cxx