broom::BroomDisableGcScope Struct Reference

#include <broom.h>

Public Member Functions
	BroomDisableGcScope ()
	~BroomDisableGcScope ()
	BroomDisableGcScope (const BroomDisableGcScope &other)=delete
	BroomDisableGcScope (BroomDisableGcScope &&other)=delete
BroomDisableGcScope &	operator= (const BroomDisableGcScope &other)=delete
BroomDisableGcScope &	operator= (BroomDisableGcScope &&other) noexcept=delete

Detailed Description

A RAII wrapper to turn the Broom garbage collector off in a given scope. Broom will never trigger a garbage collection pass automatically as long as this object exists. broom::force_collection() and broom::force_slow_collection() may still be used to trigger a garbage collection pass.

Definition at line 264 of file broom.h.

Constructor & Destructor Documentation

BroomDisableGcScope() [1/3]

broom::BroomDisableGcScope::BroomDisableGcScope ( )

inline

The constructor turns off garbage collection in a given scope. This ensures that Broom will never attempt to run a garbage collection pass automatically in this scope, unless a call to broom::force_collection() or broom::force_slow_collection() is made.

Definition at line 272 of file broom.h.

~BroomDisableGcScope()

broom::BroomDisableGcScope::~BroomDisableGcScope ( )

inline

The destructor re-enables Broom's automated garbage collection triggers.

Definition at line 276 of file broom.h.

BroomDisableGcScope() [2/3]

broom::BroomDisableGcScope::BroomDisableGcScope ( const BroomDisableGcScope &  other )

delete

BroomDisableGcScope() [3/3]

broom::BroomDisableGcScope::BroomDisableGcScope ( BroomDisableGcScope &&  other )

delete

Member Function Documentation

operator=() [1/2]

BroomDisableGcScope & broom::BroomDisableGcScope::operator= ( BroomDisableGcScope &&  other )

deletenoexcept

operator=() [2/2]

BroomDisableGcScope & broom::BroomDisableGcScope::operator= ( const BroomDisableGcScope &  other )

delete

---

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

• include/broom.h