Owning wrapper for C-API opaque handle types. More...

#include <eagine/handle.hpp>

Public Member Functions
constexpr	basic_owned_handle () noexcept=default
	Default constructor. More...

constexpr	basic_owned_handle (basic_owned_handle &&tmp) noexcept
	Move constructor.

auto	operator= (basic_owned_handle &&tmp) noexcept -> auto &
	Move assignment operator.

	basic_owned_handle (const basic_owned_handle &)=delete
	Copy constructor.

auto	operator= (const basic_owned_handle &)=delete
	Copy assignment operator.

constexpr	basic_owned_handle (base adopted) noexcept
	Constructor adopting a non-owning handle wrapper.

constexpr	basic_owned_handle (Handle name) noexcept
	Constructor adopting an underlying handle value.

auto	release () noexcept -> Handle
	Releases the underlying handle value. More...

Public Member Functions inherited from eagine::basic_handle< Tag, Handle, ~Handle(0) >
constexpr	basic_handle () noexcept=default
	Default constructor. More...

constexpr	basic_handle (basic_handle &&tmp) noexcept
	Move constructor.

constexpr	basic_handle (const basic_handle &) noexcept=default
	Copy constructor.

constexpr	basic_handle (Handle name) noexcept
	Construction from the underlying handle type.

auto	operator= (basic_handle &&tmp) noexcept -> auto &
	Move assignment operator.

auto	operator= (const basic_handle &) noexcept -> basic_handle &=default
	Copy assignment operator.

constexpr auto	is_valid () const noexcept -> bool
	Indicates if this instance contains a valid handle.

constexpr	operator bool () const noexcept
	Indicates if this instance contains a valid handle. More...

constexpr	operator Handle () const noexcept
	Explicit conversion to the underlying handle type.

Additional Inherited Members
Public Types inherited from eagine::basic_handle< Tag, Handle, ~Handle(0) >
using	tag_type = Tag
	Alias for the tag type.

using	handle_type = Handle
	Alias for the underlying handle type.

Detailed Description

template<typename Tag, typename Handle, Handle invalid = ~Handle(0)>
class eagine::basic_owned_handle< Tag, Handle, invalid >

Owning wrapper for C-API opaque handle types.

Template Parameters

Tag	type distinguisihing various handler with the same underlying type.
Handle	the underlying handle type.
invalid	the invalid value for this particular handle type.

See also: basic_handle

Constructor & Destructor Documentation

◆ basic_owned_handle()

template<typename Tag , typename Handle , Handle invalid = ~Handle(0)>

constexpr eagine::basic_owned_handle< Tag, Handle, invalid >::basic_owned_handle ( )

constexprdefaultnoexcept

Default constructor.

Postcondition: !is_valid()

Member Function Documentation

◆ release()

template<typename Tag , typename Handle , Handle invalid = ~Handle(0)>

auto eagine::basic_owned_handle< Tag, Handle, invalid >::release ( ) -> Handle

inlinenoexcept

Releases the underlying handle value.

Postcondition: !is_valid()

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

eagine/handle.hpp

Public Member Functions