Arbutils/src/Memory/borrowed_ptr.hpp

30 lines
1.0 KiB
C++
Raw Normal View History

#ifndef ARBUTILS_BORROWED_PTR_HPP
#define ARBUTILS_BORROWED_PTR_HPP
#include <memory>
/// A borrowed pointer is used to indicate a pointer that is not owned by an object, but instead borrowed from another
/// owning object that is assumed to always be kept alive during the entire lifetime of the borrowing object.
template <class T> class borrowed_ptr {
private:
T* _raw;
public:
inline borrowed_ptr<T>(T* ptr) : _raw(ptr){};
inline borrowed_ptr(const borrowed_ptr<T>& other) : _raw(other._raw){};
inline borrowed_ptr(const std::unique_ptr<T>& other) : _raw(other.get()){};
~borrowed_ptr() = default;
inline T* operator->() noexcept { return _raw; }
inline const T* operator->() const noexcept { return _raw; }
inline T* GetRaw() noexcept { return _raw; }
inline const T* GetRaw() const noexcept { return _raw; }
inline bool operator==(const borrowed_ptr& rhs) const { return _raw == rhs._raw; }
inline bool operator!=(const borrowed_ptr& rhs) const { return _raw != rhs._raw; }
};
#endif // ARBUTILS_BORROWED_PTR_HPP