blob: 1b0d6137e0e0b7a1cadca880179bf5a18cdf5466 [file] [log] [blame]
#pragma once
#include <filesystem>
#include <utility>
namespace watchdog
{
namespace dump
{
namespace fs = std::filesystem;
/**
* @class TemporaryFile
*
* A temporary file in the file system.
*
* The temporary file is created by the constructor. The absolute path to the
* file can be obtained using getPath().
*
* The temporary file can be deleted by calling remove(). Otherwise the file
* will be deleted by the destructor.
*
* TemporaryFile objects cannot be copied, but they can be moved. This enables
* them to be stored in containers like std::vector.
*/
class TemporaryFile
{
public:
// Specify which compiler-generated methods we want
TemporaryFile(const TemporaryFile&) = delete;
TemporaryFile& operator=(const TemporaryFile&) = delete;
/**
* @brief Constructor.
*
* @details Creates a temporary file in the temporary directory (normally
* /tmp).
*
* Throws an exception if the file cannot be created.
*/
TemporaryFile();
/**
* @brief Move constructor.
*
* @details Transfers ownership of a temporary file.
*
* @param file TemporaryFile object being moved
*/
TemporaryFile(TemporaryFile&& file) : path{std::move(file.path)}
{
// Clear path in other object; after move path is in unspecified state
file.path.clear();
}
/**
* @brief Move assignment operator.
*
* @details Deletes the temporary file owned by this object. Then transfers
* ownership of the temporary file owned by the other object.
*
* Throws an exception if an error occurs during the deletion.
*
* @param file TemporaryFile object being moved
*/
TemporaryFile& operator=(TemporaryFile&& file);
/**
* @brief Destructor.
*
* @details description the temporary file if necessary.
*/
~TemporaryFile()
{
try
{
remove();
}
catch (...)
{
// Destructors should not throw exceptions
}
}
/**
* @brief Deletes the temporary file.
*
* @details Does nothing if the file has already been deleted.
*
* Throws an exception if an error occurs during the deletion.
*/
void remove();
/**
* @brief Returns the absolute path to the temporary file.
*
* @details Returns an empty path if the file has been deleted.
*
* @return temporary file path
*/
const fs::path& getPath() const
{
return path;
}
private:
/**
* @brief Absolute path to the temporary file.
*
* @details Empty when file has been deleted.
*/
fs::path path{};
};
} // namespace dump
} // namespace watchdog