xrpld
Loading...
Searching...
No Matches
xrpl::detail::DirGuard Class Reference

Create a directory and remove it when it's done. More...

#include <FileDirGuard.h>

Inheritance diagram for xrpl::detail::DirGuard:
Collaboration diagram for xrpl::detail::DirGuard:

Public Member Functions

 DirGuard (beast::unit_test::Suite &test, path subDir, bool useCounter=true)
 ~DirGuard ()
path const & subdir () const

Protected Types

using path = boost::filesystem::path

Protected Member Functions

auto rmDir (path const &toRm)

Protected Attributes

beast::unit_test::Suitetest_

Private Attributes

path subDir_
bool rmSubDir_ {false}

Detailed Description

Create a directory and remove it when it's done.

Definition at line 16 of file FileDirGuard.h.

Member Typedef Documentation

◆ path

using xrpl::detail::DirGuard::path = boost::filesystem::path
protected

Definition at line 19 of file FileDirGuard.h.

Constructor & Destructor Documentation

◆ DirGuard()

xrpl::detail::DirGuard::DirGuard ( beast::unit_test::Suite & test,
path subDir,
bool useCounter = true )

Definition at line 43 of file FileDirGuard.h.

◆ ~DirGuard()

xrpl::detail::DirGuard::~DirGuard ( )

Definition at line 68 of file FileDirGuard.h.

Member Function Documentation

◆ rmDir()

auto xrpl::detail::DirGuard::rmDir ( path const & toRm)
protected

Definition at line 29 of file FileDirGuard.h.

◆ subdir()

path const & xrpl::detail::DirGuard::subdir ( ) const
nodiscard

Definition at line 85 of file FileDirGuard.h.

Member Data Documentation

◆ subDir_

path xrpl::detail::DirGuard::subDir_
private

Definition at line 22 of file FileDirGuard.h.

◆ rmSubDir_

bool xrpl::detail::DirGuard::rmSubDir_ {false}
private

Definition at line 23 of file FileDirGuard.h.

◆ test_

beast::unit_test::Suite& xrpl::detail::DirGuard::test_
protected

Definition at line 26 of file FileDirGuard.h.