sygah: Sygaldry Helpers

Modules
	sygah-consteval: consteval Workaround
	sygah-endpoints: Endpoints Helpers
	sygah-endpoints: Endpoints Bases
	sygah-metadata: Metadata Helpers
	sygah-mimu: MIMU Endpoints Helpers
	sygah-string_literal: String Literal Template Parameter Wrapper

Typedefs
using	sygaldry::num_literal< T >::type = T
	The underlying numeric type.
using	sygaldry::persistent< T >::type = T
	The underlying type.
using	sygaldry::occasional< T >::type = T
	The underlying type.
using	sygaldry::array< name_str, N, desc, T, min, max, init, Tags >::type = T
using	sygaldry::array_message< name_str, N, desc, T, min, max, init, Tags >::type = T

Enumerations
enum	{ write_only }
enum	{ session_data }
enum	{ bang , impulse }

Functions
_consteval	sygaldry::num_literal< T >::num_literal (T f)
	Constructor enabling initialization from a literal constant.
	sygaldry::num_literal< T >::operator T ()
	Conversion operator so that the num_literal can be treated roughly as if it is of T type.
static _consteval auto	sygaldry::range_< _min, _max, _init >::range ()
	Returns a struct with min, max, and init members containing the range.
static _consteval auto	sygaldry::range_< _min, _max, _init >::min ()
	Returns the minimum value of the range.
static _consteval auto	sygaldry::range_< _min, _max, _init >::max ()
	Returns the maximum value of the range.
static _consteval auto	sygaldry::range_< _min, _max, _init >::init ()
	Returns the initial value of the range.
constexpr	sygaldry::persistent< T >::persistent () noexcept
	Default constuctor defers to T's empty initializer.
constexpr	sygaldry::persistent< T >::persistent (T &&t) noexcept
	Move constructor from T
constexpr	sygaldry::persistent< T >::persistent (const T &t) noexcept
	Copy constructor from T
constexpr auto &	sygaldry::persistent< T >::operator= (T &&t) noexcept
	Move assignment from T
constexpr auto &	sygaldry::persistent< T >::operator= (const T &t) noexcept
	Copy assignment from T
constexpr	sygaldry::persistent< T >::operator T& () noexcept
	Conversion to a mutable reference to the underlying value.
constexpr	sygaldry::persistent< T >::operator const T & () const noexcept
	Conversion to a constant reference to the underlying value.
constexpr	sygaldry::occasional< T >::occasional () noexcept
	Default constructor; state is default initialized and updated is false.
constexpr	sygaldry::occasional< T >::occasional (occasional< T > &&other)
	Move constructor from another occasional.
constexpr	sygaldry::occasional< T >::occasional (const occasional< T > &other)
	Copy constructor from another occasional.
constexpr auto &	sygaldry::occasional< T >::operator= (occasional< T > &&other)
	Move assignment from another occasional.
constexpr auto &	sygaldry::occasional< T >::operator= (const occasional< T > &other)
	Copy assignment from another occasional.
constexpr	sygaldry::occasional< T >::operator T& () noexcept
	Mutable value access.
constexpr	sygaldry::occasional< T >::operator const T & () const noexcept
	Immutable value access.
constexpr	sygaldry::occasional< T >::occasional (T &&t) noexcept
	Move constructor from the underlying type.
constexpr	sygaldry::occasional< T >::occasional (const T &t) noexcept
	Copy constructor from the underlying type.
constexpr auto &	sygaldry::occasional< T >::operator= (T &&t) noexcept
	Move assignment from the underlying type.
constexpr auto &	sygaldry::occasional< T >::operator= (const T &t) noexcept
	Copy assignment from the underlying type.
constexpr T &	sygaldry::occasional< T >::operator* () noexcept
	Mutable dereference operator; provides access to the underlying state.
constexpr const T &	sygaldry::occasional< T >::operator* () const noexcept
	Constant dereference operator; provides access to the underlying state.
constexpr T *	sygaldry::occasional< T >::operator-> () noexcept
	Mutable member access operator; provides access to the members of the underlying state.
constexpr const T *	sygaldry::occasional< T >::operator-> () const noexcept
	Constant member access operator; provides access to the members of the underlying state.
constexpr T &	sygaldry::occasional< T >::value () noexcept
	Mutable value access.
constexpr const T &	sygaldry::occasional< T >::value () const noexcept
	Immutable value access.
constexpr void	sygaldry::occasional< T >::reset () noexcept
	Clear the updated flag. This can also be achieved by assignment from empty braces, e.g. x = {};
constexpr const auto &	sygaldry::array< name_str, N, desc, T, min, max, init, Tags >::operator[] (std::size_t i) const noexcept
constexpr auto &	sygaldry::array< name_str, N, desc, T, min, max, init, Tags >::operator[] (std::size_t i) noexcept
static _consteval auto	sygaldry::array< name_str, N, desc, T, min, max, init, Tags >::size () noexcept
constexpr const auto &	sygaldry::array_message< name_str, N, desc, T, min, max, init, Tags >::operator[] (std::size_t i) const noexcept
constexpr auto &	sygaldry::array_message< name_str, N, desc, T, min, max, init, Tags >::operator[] (std::size_t i) noexcept
static _consteval auto	sygaldry::array_message< name_str, N, desc, T, min, max, init, Tags >::size () noexcept
void	sygaldry::array_message< name_str, N, desc, T, min, max, init, Tags >::set_updated () noexcept
void	sygaldry::bng< name_str, desc, Tags >::operator() ()
void	sygaldry::bng< name_str, desc, Tags >::reset ()

Variables
T	sygaldry::num_literal< T >::value
	The value of the constant.
T	sygaldry::persistent< T >::value
	The wrapped value.
T	sygaldry::occasional< T >::state
	The wrapped state.
bool	sygaldry::occasional< T >::updated
	Flag indicating if the state has been changed.

Detailed Description

Function Documentation

occasional() [1/2]

template<typename T >

constexpr sygaldry::occasional< T >::occasional ( const occasional< T > &  other )

inlineconstexpr

Copy constructor from another occasional.

Only changes this wrapper if the other one has been updated. updated flag reflects whether the other occasional has been updated.

occasional() [2/2]

template<typename T >

constexpr sygaldry::occasional< T >::occasional ( occasional< T > &&  other )

inlineconstexpr

Move constructor from another occasional.

Only changes this wrapper if the other one has been updated. updated flag reflects whether the other occasional has been updated.

operator=() [1/2]

template<typename T >

constexpr auto & sygaldry::occasional< T >::operator= ( const occasional< T > &  other )

inlineconstexpr

Copy assignment from another occasional.

Only changes this wrapper if the other one has been updated. updated flag reflects whether the other occasional has been updated.

operator=() [2/2]

template<typename T >

constexpr auto & sygaldry::occasional< T >::operator= ( occasional< T > &&  other )

inlineconstexpr

Move assignment from another occasional.

Only changes this wrapper if the other one has been updated. updated flag reflects whether the other occasional has been updated.