detach_cast.hpp File Reference

#include "bit_cast.hpp"
#include "byte.hpp"
#include "span.hpp"
#include "type_traits.hpp"
#include <cstring>
#include <type_traits>

Classes
struct	quickcpplib::_xxx::detach_cast::traits::enable_reinterpret_detach_cast< T >
	Specialise to true if you want to enable the reinterpret cast based implementation of detach_cast() for some type T. This introduces undefined behaviour in C++ 20. More...
struct	quickcpplib::_xxx::detach_cast::traits::enable_reinterpret_attach_cast< T >
	Specialise to true if you want to enable the reinterpret cast based implementation of attach_cast() for some type T. This introduces undefined behaviour in C++ 20. More...

Namespaces
namespace	quickcpplib
	The QuickCppLib namespace.
namespace	quickcpplib::_xxx
	Per commit unique namespace to prevent different git submodule versions clashing.
namespace	quickcpplib::_xxx::detach_cast
namespace	quickcpplib::_xxx::detach_cast::traits
	Namespace for user specialised traits.
namespace	quickcpplib::_xxx::detach_cast::detail

Typedefs
template<class T >
using	quickcpplib::_xxx::detach_cast::byte_array_reference = byte(&)[sizeof(T)]
	A reference to a byte array sized the same as T
template<class T >
using	quickcpplib::_xxx::detach_cast::const_byte_array_reference = const byte(&)[sizeof(T)]
	A const reference to a byte array sized the same as const T

Functions
template<class To , class From , typename = decltype( quickcpplib::_xxx ::bit_cast::bit_cast<To, From>(std::declval<From>()) )>
constexpr bool	quickcpplib::_xxx::detach_cast::detail::_is_bit_cast_valid (int)
template<class To , class From >
constexpr bool	quickcpplib::_xxx::detach_cast::detail::_is_bit_cast_valid (...)
template<class To , class From >
constexpr bool	quickcpplib::_xxx::detach_cast::detail::is_bit_cast_valid ()
template<class T , typename std::enable_if<(!detail::is_bit_cast_valid< detail::byte_array_wrapper< T >, T >() &&!traits::enable_reinterpret_detach_cast< typename std::decay< T >::type >::value), bool >::type = true>
QUICKCPPLIB_NODISCARD constexpr byte_array_reference< T >	quickcpplib::_xxx::detach_cast::detach_cast (const T &,...) noexcept
	Detaches a live object into its detached byte representation, ending the lifetime of the input object, and beginning the lifetime of an array of byte sized exactly the size of the input object at the same memory location, which is returned. All references to the input object become INVALID. Any use of the input object after detachment has occurred is illegal!
template<class T , typename std::enable_if<(!detail::is_bit_cast_valid< T, detail::byte_array_wrapper< T > >() &&!traits::enable_reinterpret_attach_cast< typename std::decay< T >::type >::value), bool >::type = true>
QUICKCPPLIB_NODISCARD constexpr T &	quickcpplib::_xxx::detach_cast::attach_cast (const_byte_array_reference< T > &,...) noexcept
	Reattaches a previously detached object, beginning the lifetime of the output object, and ending the lifetime of the input array of byte. All references to the input byte array become INVALID. Any use of the input array after attachment has occurred is illegal!
template<class T , typename std::enable_if<(detail::is_bit_cast_valid< detail::byte_array_wrapper< T >, T >() &&!traits::enable_reinterpret_detach_cast< typename std::decay< T >::type >::value), bool >::type = true>
QUICKCPPLIB_NODISCARD constexpr byte_array_reference< T >	quickcpplib::_xxx::detach_cast::detach_cast (T &v, detail::bit_castable_overload={}) noexcept
	Detaches a non-const bit-castable object into its detached non-const byte representation, ending the lifetime of the input object. Defined behaviour in C++ 20 (though only the clang compiler currently reliably does not copy the byte array twice. GCC avoids the memory copy for small objects, MSVC always copies the byte array twice).
template<class T , typename std::enable_if<(detail::is_bit_cast_valid< const detail::byte_array_wrapper< T >, const T >() &&!traits::enable_reinterpret_detach_cast< typename std::decay< T >::type >::value), bool >::type = true>
QUICKCPPLIB_NODISCARD constexpr const_byte_array_reference< T >	quickcpplib::_xxx::detach_cast::detach_cast (const T &v, detail::bit_castable_overload={}) noexcept
	Detaches a const bit-castable object into its detached const byte representation, ending the lifetime of the input object. Defined behaviour in C++ 20 (though only the clang compiler currently reliably does not copy the byte array twice. GCC avoids the memory copy for small objects, MSVC always copies the byte array twice).
template<class T , typename std::enable_if<(detail::is_bit_cast_valid< T, detail::byte_array_wrapper< T > >() &&!traits::enable_reinterpret_attach_cast< typename std::decay< T >::type >::value &&!std::is_const< T >::value), bool >::type = true>
QUICKCPPLIB_NODISCARD constexpr T &	quickcpplib::_xxx::detach_cast::attach_cast (byte_array_reference< T > v, detail::bit_castable_overload={}) noexcept
	Attaches a non-const bit-castable object from its detached non-const byte representation, ending the lifetime of the input array. Defined behaviour in C++ 20 (though only the clang compiler currently reliably does not copy the byte array twice. GCC avoids the memory copy for small objects, MSVC always copies the byte array twice).
template<class T , typename std::enable_if<(detail::is_bit_cast_valid< T, const detail::byte_array_wrapper< T > >() &&!traits::enable_reinterpret_attach_cast< typename std::decay< T >::type >::value &&std::is_const< T >::value), bool >::type = true>
QUICKCPPLIB_NODISCARD constexpr const T &	quickcpplib::_xxx::detach_cast::attach_cast (const_byte_array_reference< T > v, detail::bit_castable_overload={}) noexcept
	Attaches a const bit-castable object from its detached const byte representation, ending the lifetime of the input array. Defined behaviour in C++ 20 (though only the clang compiler currently reliably does not copy the byte array twice. GCC avoids the memory copy for small objects, MSVC always copies the byte array twice).
template<class T , typename std::enable_if<(!detail::is_bit_cast_valid< detail::byte_array_wrapper< T >, T >() &&traits::enable_reinterpret_detach_cast< typename std::decay< T >::type >::value), bool >::type = true>
QUICKCPPLIB_NODISCARD constexpr byte_array_reference< T >	quickcpplib::_xxx::detach_cast::detach_cast (T &v, detail::reinterpret_cast_overload={}) noexcept
	Reinterpret casts a non-const object reference into a non-const byte representation. Pure undefined behaviour. Available only if traits::enable_reinterpret_detach_cast<T> is true for the type.
template<class T , typename std::enable_if<(!detail::is_bit_cast_valid< const detail::byte_array_wrapper< T >, const T >() &&traits::enable_reinterpret_detach_cast< typename std::decay< T >::type >::value), bool >::type = true>
QUICKCPPLIB_NODISCARD constexpr const_byte_array_reference< T >	quickcpplib::_xxx::detach_cast::detach_cast (const T &v, detail::reinterpret_cast_overload={}) noexcept
	Reinterpret casts a const object reference into a const byte representation. Pure undefined behaviour. Available only if traits::enable_reinterpret_detach_cast<T> is true for the type.
template<class T , typename std::enable_if<(!detail::is_bit_cast_valid< T, detail::byte_array_wrapper< T > >() &&traits::enable_reinterpret_attach_cast< typename std::decay< T >::type >::value &&!std::is_const< T >::value), bool >::type = true>
QUICKCPPLIB_NODISCARD constexpr T &	quickcpplib::_xxx::detach_cast::attach_cast (byte_array_reference< T > v, detail::reinterpret_cast_overload={}) noexcept
	Reinterpret casts a const byte representation into a const object. Pure undefined behaviour. Available only if traits::enable_reinterpret_attach_cast<T> is true for the type.
template<class T , typename std::enable_if<(!detail::is_bit_cast_valid< const T, const detail::byte_array_wrapper< T > >() &&traits::enable_reinterpret_attach_cast< typename std::decay< T >::type >::value &&std::is_const< T >::value), bool >::type = true>
QUICKCPPLIB_NODISCARD constexpr T &	quickcpplib::_xxx::detach_cast::attach_cast (const_byte_array_reference< T > v, detail::reinterpret_cast_overload={}) noexcept
	Reinterpret casts a non-const byte representation into a non-const object. Pure undefined behaviour. Available only if traits::enable_reinterpret_attach_cast<T> is true for the type.