cosmos::TempDir Class Reference

Creation and lifetime management for temporary directories. More...

#include <TempDir.hxx>

Public Member Functions
	TempDir (const SysString _template)
	TempDir (const TempDir &)=delete
TempDir &	operator= (const TempDir &)=delete
	TempDir (TempDir &&other) noexcept
TempDir &	operator= (TempDir &&other) noexcept
void	close ()
void	create (const SysString _template)
const std::string &	path () const
	Returns the expanded path to the temporary dir.

Protected Attributes
std::string	m_tmp_path

Detailed Description

Creation and lifetime management for temporary directories.

Create a temporary directory based on a name template. See fs::make_tempdir() for details on the template requirements.

Upon close() the temporary directory will be recursively removed.

Definition at line 15 of file TempDir.hxx.

Constructor & Destructor Documentation

TempDir() [1/2]

cosmos::TempDir::TempDir ( const SysString _template )

inlineexplicit

Definition at line 20 of file TempDir.hxx.

                                                    {
                create(_template);
        }

~TempDir()

cosmos::TempDir::~TempDir

(

)

Definition at line 9 of file TempDir.cxx.

                  {
        try {
                close();
        } catch (const std::exception &e) {
                noncritical_error("Failed to close TmpDir", e);
        }
}

TempDir() [2/2]

cosmos::TempDir::TempDir ( TempDir && other )

inlinenoexcept

Definition at line 30 of file TempDir.hxx.

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

Member Function Documentation

close()

void cosmos::TempDir::close ( )

inline

Definition at line 40 of file TempDir.hxx.

                     {
                if (!m_tmp_path.empty()) {
                        fs::remove_tree(m_tmp_path);
                        m_tmp_path.clear();
                }
        }

create()

void cosmos::TempDir::create

(

const SysString

_template

)

Definition at line 17 of file TempDir.cxx.

                                              {
        close();
        m_tmp_path = fs::make_tempdir(fs::normalize_path(_template));
}

operator=()

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

inlinenoexcept

Definition at line 34 of file TempDir.hxx.

                                                     {
                m_tmp_path = other.m_tmp_path;
                other.m_tmp_path.clear();
                return *this;
        }

path()

const std::string & cosmos::TempDir::path

(

)

const

Returns the expanded path to the temporary dir.

This is only valid if currently a temporary file is open. Otherwise a UsageError will be thrown.

Definition at line 22 of file TempDir.cxx.

                                     {
        if (!m_tmp_path.empty())
                return m_tmp_path;
 
        cosmos_throw (UsageError("accessed path for closed TempDir"));
        return m_tmp_path; // to silence compiler warning
}

Member Data Documentation

m_tmp_path

std::string cosmos::TempDir::m_tmp_path

protected

Definition at line 58 of file TempDir.hxx.

---

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

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