juce::ErasedScopeGuard Class Reference

A ScopeGuard that uses a std::function internally to allow type erasure. More...

#include "juce_ScopeGuard.h"

Public Member Functions
	ErasedScopeGuard ()=default
	Constructs an ErasedScopeGuard with no callback.
	ErasedScopeGuard (std::function< void()> d)
	Constructs an ErasedScopeGuard that will call the provided callback when the Guard is destroyed.
	ErasedScopeGuard (ErasedScopeGuard &&other) noexcept
	Constructs an instance that assumes responsibility for calling other's callback.
ErasedScopeGuard &	operator= (ErasedScopeGuard &&other) noexcept
	Calls the stored callback, if any, then assumes responsibility for calling other's callback.
	~ErasedScopeGuard () noexcept
	Destructor, calls the callback assigned to this ScopeGuard.
void	reset ()
	Calls the stored callback, if any, then resets this instance to its default state.
void	release ()
	Resets this instance to its default state without calling the stored callback.

Detailed Description

A ScopeGuard that uses a std::function internally to allow type erasure.

This can be handy; it allows lots of ErasedScopeGuards, all with different callbacks, to be stored in a homogeneous container.

An instance of this type will automatically call its callback when it is destroyed.

ErasedScopeGuard has a few similarities with std::unique_ptr:

• Calling reset() on a unique_ptr destroys the object if it hasn't been destroyed yet and puts the unique_ptr back into a default/null state; calling reset() on an ErasedScopeGuard calls the callback if it hasn't been called yet and puts the Guard back into a default/null state.
• Calling release() on a unique_ptr returns the unique_ptr back to a default state without destroying the managed object; calling release() on an ErasedScopeGuard returns the Guard back to a default state without calling the callback.
• Moving a unique_ptr transfers the responsibility of destroying the managed object to another unique_ptr instance; moving an ErasedScopeGuard transfers the responsibility of calling the callback to another Guard instance.

@tags{Core}

Definition at line 76 of file juce_ScopeGuard.h.

Constructor & Destructor Documentation

ErasedScopeGuard() [1/2]

juce::ErasedScopeGuard::ErasedScopeGuard ( std::function< void()>  d )

explicit

Constructs an ErasedScopeGuard that will call the provided callback when the Guard is destroyed.

Definition at line 26 of file juce_ScopeGuard.cpp.

ErasedScopeGuard() [2/2]

juce::ErasedScopeGuard::ErasedScopeGuard ( ErasedScopeGuard &&  other )

noexcept

Constructs an instance that assumes responsibility for calling other's callback.

Definition at line 29 of file juce_ScopeGuard.cpp.

~ErasedScopeGuard()

juce::ErasedScopeGuard::~ErasedScopeGuard ( )

noexcept

Destructor, calls the callback assigned to this ScopeGuard.

Definition at line 39 of file juce_ScopeGuard.cpp.

Member Function Documentation

operator=()

ErasedScopeGuard & juce::ErasedScopeGuard::operator= ( ErasedScopeGuard &&  other )

noexcept

Calls the stored callback, if any, then assumes responsibility for calling other's callback.

After this call, other will be reset to its default state.

Definition at line 32 of file juce_ScopeGuard.cpp.

release()

void juce::ErasedScopeGuard::release

(

)

Resets this instance to its default state without calling the stored callback.

Definition at line 50 of file juce_ScopeGuard.cpp.

reset()

void juce::ErasedScopeGuard::reset

(

)

Calls the stored callback, if any, then resets this instance to its default state.

Definition at line 44 of file juce_ScopeGuard.cpp.

---

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

• juce_core/misc/juce_ScopeGuard.h
• juce_core/misc/juce_ScopeGuard.cpp