Botan::scoped_cleanup< FunT > Class Template Reference

Helper class to create a RAII-style cleanup callback. More...

#include <stl_util.h>

Public Member Functions
void	disengage ()
scoped_cleanup &	operator= (const scoped_cleanup &)=delete
scoped_cleanup &	operator= (scoped_cleanup &&other)
	scoped_cleanup (const scoped_cleanup &)=delete
	scoped_cleanup (FunT cleanup)
	scoped_cleanup (scoped_cleanup &&other)
	~scoped_cleanup ()

Detailed Description

template<std::invocable FunT>
class Botan::scoped_cleanup< FunT >

Helper class to create a RAII-style cleanup callback.

Ensures that the cleanup callback given in the object's constructor is called when the object is destroyed. Use this to ensure some cleanup code runs when leaving the current scope.

Definition at line 355 of file stl_util.h.

Constructor & Destructor Documentation

scoped_cleanup() [1/3]

template<std::invocable FunT>

Botan::scoped_cleanup< FunT >::scoped_cleanup ( FunT cleanup )

inlineexplicit

Definition at line 357 of file stl_util.h.

: m_cleanup(std::move(cleanup)) {}

Referenced by operator=(), operator=(), scoped_cleanup(), and scoped_cleanup().

scoped_cleanup() [2/3]

template<std::invocable FunT>

Botan::scoped_cleanup< FunT >::scoped_cleanup ( const scoped_cleanup< FunT > & )

delete

References scoped_cleanup().

scoped_cleanup() [3/3]

template<std::invocable FunT>

Botan::scoped_cleanup< FunT >::scoped_cleanup ( scoped_cleanup< FunT > && other )

inline

Definition at line 362 of file stl_util.h.

: m_cleanup(std::move(other.m_cleanup)) { other.disengage(); }

References scoped_cleanup().

~scoped_cleanup()

template<std::invocable FunT>

Botan::scoped_cleanup< FunT >::~scoped_cleanup ( )

inline

Definition at line 372 of file stl_util.h.

                        {
         if(m_cleanup.has_value()) {
            m_cleanup.value()();
         }
      }

Member Function Documentation

disengage()

template<std::invocable FunT>

void Botan::scoped_cleanup< FunT >::disengage ( )

inline

Disengage the cleanup callback, i.e., prevent it from being called

Definition at line 381 of file stl_util.h.

{ m_cleanup.reset(); }

operator=() [1/2]

template<std::invocable FunT>

scoped_cleanup & Botan::scoped_cleanup< FunT >::operator= ( const scoped_cleanup< FunT > & )

delete

References scoped_cleanup().

operator=() [2/2]

template<std::invocable FunT>

scoped_cleanup & Botan::scoped_cleanup< FunT >::operator= ( scoped_cleanup< FunT > && other )

inline

Definition at line 364 of file stl_util.h.

                                                        {
         if(this != &other) {
            m_cleanup = std::move(other.m_cleanup);
            other.disengage();
         }
         return *this;
      }

References scoped_cleanup().

---

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

• src/lib/utils/stl_util.h