helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch > Class Template Reference

Implements pimpl idiom without dynamic memory allocation. More...

#include <fast_pimpl.hpp>

Public Member Functions
template<typename... Args>
	explicit (sizeof...(Args)==1) const expr FastPimpl(Args &&... args) noexcept(std::is_nothrow_constructible_v< T, Args... >)
constexpr	FastPimpl (const FastPimpl &other) noexcept(noexcept(FastPimpl(std::declval< const T & >())))
constexpr	FastPimpl (FastPimpl &&other) noexcept(noexcept(FastPimpl(std::declval< T && >())))
constexpr	~FastPimpl () noexcept(noexcept(std::destroy_at(std::declval< T * >())))
constexpr FastPimpl &	operator= (const FastPimpl &rhs) noexcept(noexcept(std::declval< T & >()=std::declval< const T & >()))
constexpr FastPimpl &	operator= (FastPimpl &&rhs) noexcept(noexcept(std::declval< T & >()=std::declval< T && >()))
constexpr FastPimpl &	operator= (const T &value) noexcept(noexcept(std::declval< T & >()=std::declval< const T & >()))
	Copy-assigns from a T instance.
constexpr FastPimpl &	operator= (T &&value) noexcept(noexcept(std::declval< T & >()=std::declval< T && >()))
	Move-assigns from a T instance.
constexpr T *	operator-> () noexcept
constexpr const T *	operator-> () const noexcept
constexpr T &	operator* () noexcept
constexpr const T &	operator* () const noexcept

Detailed Description

template<class T, size_t Size, size_t Alignment, bool RequireStrictMatch = false>
class helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >

Implements pimpl idiom without dynamic memory allocation.

FastPimpl doesn't require memory allocation or indirect memory access. You must manually set object size and alignment when instantiating FastPimpl.

Template Parameters

T	The implementation type
Size	The size in bytes to allocate for T
Alignment	The alignment requirement for T
RequireStrictMatch	If true, requires exact size/alignment match

Definition at line 24 of file fast_pimpl.hpp.

Constructor & Destructor Documentation

FastPimpl() [1/2]

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch = false>

constexpr helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::FastPimpl ( const FastPimpl< T, Size, Alignment, RequireStrictMatch > &  other )

inlineconstexprnoexcept

Definition at line 32 of file fast_pimpl.hpp.

      : FastPimpl(*other) {}

FastPimpl() [2/2]

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch = false>

constexpr helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::FastPimpl ( FastPimpl< T, Size, Alignment, RequireStrictMatch > &&  other )

inlineconstexprnoexcept

Definition at line 35 of file fast_pimpl.hpp.

      : FastPimpl(std::move(*other)) {}

~FastPimpl()

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch>

constexpr helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::~FastPimpl ( )

constexprnoexcept

Definition at line 73 of file fast_pimpl.hpp.

                                               {
  ValidateConstraints();
  std::destroy_at(Impl());
}

Member Function Documentation

explicit()

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch = false>

template<typename... Args>

helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::explicit ( sizeof...  Args = = 1 ) const &&

inlinenoexcept

Definition at line 27 of file fast_pimpl.hpp.

                                                                                                      {
    std::construct_at(Impl(), std::forward<Args>(args)...);
  }

operator*() [1/2]

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch = false>

constexpr const T & helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::operator* ( ) const

inlineconstexprnoexcept

Definition at line 61 of file fast_pimpl.hpp.

{ return *Impl(); }

operator*() [2/2]

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch = false>

constexpr T & helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::operator* ( )

inlineconstexprnoexcept

Definition at line 60 of file fast_pimpl.hpp.

{ return *Impl(); }

operator->() [1/2]

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch = false>

constexpr const T * helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::operator-> ( ) const

inlineconstexprnoexcept

Definition at line 59 of file fast_pimpl.hpp.

{ return Impl(); }

operator->() [2/2]

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch = false>

constexpr T * helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::operator-> ( )

inlineconstexprnoexcept

Definition at line 58 of file fast_pimpl.hpp.

{ return Impl(); }

operator=() [1/4]

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch>

constexpr auto helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::operator= ( const FastPimpl< T, Size, Alignment, RequireStrictMatch > &  rhs )

constexprnoexcept

Definition at line 80 of file fast_pimpl.hpp.

                                                                       {
  if (this != &rhs) [[likely]] {
    *Impl() = *rhs;
  }
  return *this;
}

operator=() [2/4]

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch>

constexpr auto helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::operator= ( const T &  value )

constexprnoexcept

Copy-assigns from a T instance.

Parameters

value

Source value

Returns

Reference to this instance

Definition at line 98 of file fast_pimpl.hpp.

                                                                       {
  if (Impl() != &value) [[likely]] {
    *Impl() = value;
  }
  return *this;
}

operator=() [3/4]

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch>

constexpr auto helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::operator= ( FastPimpl< T, Size, Alignment, RequireStrictMatch > &&  rhs )

constexprnoexcept

Definition at line 89 of file fast_pimpl.hpp.

                                                                  {
  if (this != &rhs) [[likely]] {
    *Impl() = std::move(*rhs);
  }
  return *this;
}

operator=() [4/4]

template<class T , size_t Size, size_t Alignment, bool RequireStrictMatch>

constexpr auto helios::utils::FastPimpl< T, Size, Alignment, RequireStrictMatch >::operator= ( T &&  value )

constexprnoexcept

Move-assigns from a T instance.

Parameters

value

Source value

Returns

Reference to this instance

Definition at line 107 of file fast_pimpl.hpp.

                                                                  {
  if (Impl() != &value) [[likely]] {
    *Impl() = std::move(value);
  }
  return *this;
}