Toolbox snapshot
The Reactive C++ Toolbox
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
toolbox::io::BasicHandle< PolicyT > Class Template Reference

#include <toolbox/io/Handle.hpp>

Public Types

using Id = typename PolicyT::Id
 

Public Member Functions

constexpr BasicHandle (std::nullptr_t=nullptr) noexcept
 
constexpr BasicHandle (Id id) noexcept
 
 ~BasicHandle ()
 
 BasicHandle (const BasicHandle &)=delete
 
BasicHandleoperator= (const BasicHandle &)=delete
 
constexpr BasicHandle (BasicHandle &&rhs) noexcept
 
BasicHandleoperator= (BasicHandle &&rhs) noexcept
 
constexpr bool empty () const noexcept
 
constexpr operator bool () const noexcept
 
constexpr Id get () const noexcept
 
constexpr Id operator* () const noexcept
 
Id release () noexcept
 
void reset (std::nullptr_t=nullptr) noexcept
 
void reset (Id id) noexcept
 
void swap (BasicHandle &rhs) noexcept
 

Static Public Member Functions

static constexpr Id invalid () noexcept
 

Detailed Description

template<typename PolicyT>
class toolbox::io::BasicHandle< PolicyT >

Definition at line 28 of file Handle.hpp.

Member Typedef Documentation

◆ Id

Definition at line 30 of file Handle.hpp.

Constructor & Destructor Documentation

◆ BasicHandle() [1/4]

template<typename PolicyT >
constexpr toolbox::io::BasicHandle< PolicyT >::BasicHandle ( std::nullptr_t  = nullptr)
inlineconstexprnoexcept

Definition at line 34 of file Handle.hpp.

◆ BasicHandle() [2/4]

template<typename PolicyT >
constexpr toolbox::io::BasicHandle< PolicyT >::BasicHandle ( Id  id)
inlineconstexprnoexcept

Definition at line 36 of file Handle.hpp.

◆ ~BasicHandle()

Definition at line 40 of file Handle.hpp.

◆ BasicHandle() [3/4]

template<typename PolicyT >
toolbox::io::BasicHandle< PolicyT >::BasicHandle ( const BasicHandle< PolicyT > &  )
delete

◆ BasicHandle() [4/4]

template<typename PolicyT >
constexpr toolbox::io::BasicHandle< PolicyT >::BasicHandle ( BasicHandle< PolicyT > &&  rhs)
inlineconstexprnoexcept

Definition at line 52 of file Handle.hpp.

Member Function Documentation

◆ invalid()

template<typename PolicyT >
static constexpr Id toolbox::io::BasicHandle< PolicyT >::invalid ( )
inlinestaticconstexprnoexcept

◆ operator=() [1/2]

◆ operator=() [2/2]

Definition at line 57 of file Handle.hpp.

◆ empty()

template<typename PolicyT >
constexpr bool toolbox::io::BasicHandle< PolicyT >::empty ( ) const
inlineconstexprnoexcept

Definition at line 64 of file Handle.hpp.

◆ operator bool()

template<typename PolicyT >
constexpr toolbox::io::BasicHandle< PolicyT >::operator bool ( ) const
inlineexplicitconstexprnoexcept

Definition at line 65 of file Handle.hpp.

◆ get()

template<typename PolicyT >
constexpr Id toolbox::io::BasicHandle< PolicyT >::get ( ) const
inlineconstexprnoexcept

◆ operator*()

template<typename PolicyT >
constexpr Id toolbox::io::BasicHandle< PolicyT >::operator* ( ) const
inlineconstexprnoexcept

Definition at line 68 of file Handle.hpp.

◆ release()

template<typename PolicyT >
Id toolbox::io::BasicHandle< PolicyT >::release ( )
inlinenoexcept

Definition at line 70 of file Handle.hpp.

◆ reset() [1/2]

template<typename PolicyT >
void toolbox::io::BasicHandle< PolicyT >::reset ( std::nullptr_t  = nullptr)
inlinenoexcept

◆ reset() [2/2]

template<typename PolicyT >
void toolbox::io::BasicHandle< PolicyT >::reset ( Id  id)
inlinenoexcept

Definition at line 77 of file Handle.hpp.

◆ swap()

template<typename PolicyT >
void toolbox::io::BasicHandle< PolicyT >::swap ( BasicHandle< PolicyT > &  rhs)
inlinenoexcept

Definition at line 84 of file Handle.hpp.

Referenced by toolbox::io::BasicHandle< PolicyT >::operator=().


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