mtcore::Rc< T > Struct Template Reference

Thread-local reference counted pointer Not thread safe, don't share Reference counting for cleaning up memory Supports weak references as well. More...

#include <rc.hpp>

Public Member Functions
T &	operator* ()
	Dereferences pointer.
const T &	operator* () const
	Dereferences pointer.
T *	operator-> ()
	Dereferences pointer.
const T *	operator-> () const
	Dereferences pointer.
bool	operator== (const Rc &other) const
	Compares to a pointer.
bool	operator== (T *other) const
	Compares to a pointer.
bool	operator== (const T *other) const
	Compares to a pointer.
bool	valid () const
	Checks if is valid.
	operator bool () const
	Checks if is valid.
template<typename... Args>
Result< void, AllocationError >	init (Allocator &alloc, Args... args)
	Initializes a reference counter to point to a new entity.
Result< Rc, RcError >	acquire ()
	Tries to acquire another strong reference Will return either another strong reference or an error.
void	release (Allocator &alloc)
	Releases a reference.
void	deinit (Allocator &alloc)
	Same as release.
Result< WeakRc< T >, RcError >	weak ()
	Attempts to get a weak reference.

Public Attributes
impl::ThreadLocalRefCount< T > *	rc = nullptr

Detailed Description

template<typename T>
struct mtcore::Rc< T >

Thread-local reference counted pointer Not thread safe, don't share Reference counting for cleaning up memory Supports weak references as well.

Template Parameters

T	Type pointed to

Definition at line 155 of file rc.hpp.

Member Function Documentation

acquire()

template<typename T>

Result< Rc, RcError > mtcore::Rc< T >::acquire ( )

inlinenodiscard

Tries to acquire another strong reference Will return either another strong reference or an error.

Definition at line 243 of file rc.hpp.

                                                {
      ensure(rc, "Rc is invalid");
      if (!rc->acquireStrong()) {
        return error(RcError::CANNOT_ACQUIRE);
      }
      ensure(rc->value, "Rc  is invalid");
      return *this;
    }

Here is the call graph for this function:

deinit()

template<typename T>

void mtcore::Rc< T >::deinit ( Allocator & alloc )

inline

Same as release.

See also

release

Definition at line 279 of file rc.hpp.

                                  {
      release(alloc);
    }

Here is the call graph for this function:

init()

template<typename T>

template<typename... Args>

Result< void, AllocationError > mtcore::Rc< T >::init ( Allocator & alloc, Args... args )

inlinenodiscard

Initializes a reference counter to point to a new entity.

Template Parameters

Args	Types of constructor arguments

Parameters

alloc	Allocator for initial allocation
args	Arguments to use for construction

Returns

Success or allocation error

Definition at line 219 of file rc.hpp.

                                                                                     {
      if (rc) {
        release(alloc);
      }
      Result<T*, AllocationError> valRes = alloc.create<T>(args...);
      if (valRes.is_error()) {
        return valRes.error();
      }
      T* val = valRes.value();
 
      auto rcRes = alloc.create<impl::ThreadLocalRefCount<T>>();
      if (rcRes.is_error()) {
        alloc.destroy(val);
        return error(AllocationError::ALLOCATION_FAILED);
      }
      rc = rcRes.value();
      rc->value = val;
      return success();
    }

Here is the call graph for this function:

operator bool()

template<typename T>

mtcore::Rc< T >::operator bool ( ) const

inlinenodiscard

Checks if is valid.

Definition at line 209 of file rc.hpp.

{ return valid(); }

Here is the call graph for this function:

operator*() [1/2]

template<typename T>

T & mtcore::Rc< T >::operator* ( )

inlinenodiscard

Dereferences pointer.

Definition at line 159 of file rc.hpp.

                                 {
      ensure(rc, "Invalid Rc");
      return *rc->value;
    }

operator*() [2/2]

template<typename T>

const T & mtcore::Rc< T >::operator* ( ) const

inlinenodiscard

Dereferences pointer.

Definition at line 165 of file rc.hpp.

                                             {
      ensure(rc, "Invalid Rc");
      return *rc->value;
    }

operator->() [1/2]

template<typename T>

T * mtcore::Rc< T >::operator-> ( )

inlinenodiscard

Dereferences pointer.

Definition at line 171 of file rc.hpp.

                                  {
      ensure(rc, "Invalid Rc");
      return rc->value;
    }

operator->() [2/2]

template<typename T>

const T * mtcore::Rc< T >::operator-> ( ) const

inlinenodiscard

Dereferences pointer.

Definition at line 177 of file rc.hpp.

                                              {
      ensure(rc, "Invalid Rc");
      return rc->value;
    }

operator==() [1/3]

template<typename T>

bool mtcore::Rc< T >::operator== ( const Rc< T > & other ) const

inlinenodiscard

Compares to a pointer.

Definition at line 183 of file rc.hpp.

                                                         {
      return rc == other.rc;
    }

operator==() [2/3]

template<typename T>

bool mtcore::Rc< T >::operator== ( const T * other ) const

inlinenodiscard

Compares to a pointer.

Definition at line 197 of file rc.hpp.

                                                        {
      if (other == nullptr && rc == nullptr) {
        return true;
      }
      ensure(rc, "Invalid Rc");
      return rc->value == other;
    }

operator==() [3/3]

template<typename T>

bool mtcore::Rc< T >::operator== ( T * other ) const

inlinenodiscard

Compares to a pointer.

Definition at line 188 of file rc.hpp.

                                                  {
      if (other == nullptr && rc == nullptr) {
        return true;
      }
      ensure(rc, "Invalid Rc");
      return rc->value == other;
    }

release()

template<typename T>

void mtcore::Rc< T >::release ( Allocator & alloc )

inline

Releases a reference.

May clean up object

Parameters

alloc

Allocator to use for potential cleanup

Definition at line 256 of file rc.hpp.

                                   {
      if (!rc) {
        return;
      }
      ensure(rc, "Rc is invalid");
      ensure(rc->value, "Rc is invalid");
      switch (impl::StrongReleaseAction action = rc->releaseStrong()) {
        case impl::StrongReleaseAction::NONE:
          break;
        case impl::StrongReleaseAction::CLEANUP_RC:
          alloc.destroy(rc->value);
          rc->value = nullptr;
          alloc.destroy(rc);
          break;
        case impl::StrongReleaseAction::CLEANUP_VAR_ONLY:
          alloc.destroy(rc->value);
          rc->value = nullptr;
          break;
      }
      rc = nullptr;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

valid()

template<typename T>

bool mtcore::Rc< T >::valid ( ) const

inlinenodiscard

Checks if is valid.

Definition at line 206 of file rc.hpp.

{ return rc != nullptr && rc->value != nullptr; }

Here is the caller graph for this function:

weak()

template<typename T>

Result< WeakRc< T >, RcError > mtcore::Rc< T >::weak ( )

inline

Attempts to get a weak reference.

Definition at line 286 of file rc.hpp.

                                      {
      ensure(rc, "Invalid Rc");
      if (!rc->acquireWeak()) {
        return error(RcError::CANNOT_ACQUIRE);
      }
      return success(WeakRc<T>{rc});
    }

Here is the call graph for this function:

Member Data Documentation

rc

template<typename T>

impl::ThreadLocalRefCount<T>* mtcore::Rc< T >::rc = nullptr

Definition at line 156 of file rc.hpp.

---

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

• rc.hpp