esphome::TemplatableValue< T, X > Class Template Reference

#include <automation.h>

Public Member Functions
	TemplatableValue ()
	TemplatableValue (const char *str)
template<typename F > requires (!std::invocable<F, X...>)
	TemplatableValue (F value)
template<typename F > requires std::invocable<F, X...> && std::convertible_to<F, T (*)(X...)>
	TemplatableValue (F f)
template<typename F > requires std::invocable<F, X...> &&(!std::convertible_to<F, T (*)(X...)>)
	TemplatableValue (F f)
	TemplatableValue (const TemplatableValue &other)
	TemplatableValue (TemplatableValue &&other) noexcept
TemplatableValue &	operator= (const TemplatableValue &other)
TemplatableValue &	operator= (TemplatableValue &&other) noexcept
	~TemplatableValue ()
bool	has_value () const
T	value (X... x) const
optional< T >	optional_value (X... x)
T	value_or (X... x, T default_value)
bool	is_static_string () const
	Check if this holds a static string (const char* stored without allocation)
const char *	get_static_string () const
	Get the static string pointer (only valid if is_static_string() returns true)
bool	is_empty () const
	Check if the string value is empty without allocating (for std::string specialization).
StringRef	ref_or_copy_to (char *lambda_buf, size_t lambda_buf_size) const
	Get a StringRef to the string value without heap allocation when possible.

Protected Types
enum	: uint8_t {   NONE , VALUE , LAMBDA , STATELESS_LAMBDA ,   STATIC_STRING }
using	ValueStorage = std::conditional_t<USE_HEAP_STORAGE, T *, T>

Protected Attributes
enum esphome::TemplatableValue:: { ... }	type_
union {
ValueStorage   value_
std::function< T(X...)> *   f_
T(*   stateless_f_ )(X...)
const char *   static_str_
};

Detailed Description

template<typename T, typename... X>
class esphome::TemplatableValue< T, X >

Definition at line 45 of file automation.h.

Member Typedef Documentation

ValueStorage

template<typename T , typename... X>

using esphome::TemplatableValue< T, X >::ValueStorage = std::conditional_t<USE_HEAP_STORAGE, T *, T>

protected

Definition at line 245 of file automation.h.

Member Enumeration Documentation

anonymous enum

template<typename T , typename... X>

anonymous enum : uint8_t

protected

Enumerator
NONE
VALUE
LAMBDA
STATELESS_LAMBDA
STATIC_STRING

Definition at line 236 of file automation.h.

Constructor & Destructor Documentation

TemplatableValue() [1/7]

template<typename T , typename... X>

esphome::TemplatableValue< T, X >::TemplatableValue ( )

inline

Definition at line 51 of file automation.h.

TemplatableValue() [2/7]

template<typename T , typename... X>

esphome::TemplatableValue< T, X >::TemplatableValue ( const char * str )

inline

Definition at line 55 of file automation.h.

TemplatableValue() [3/7]

template<typename T , typename... X>

template<typename F >
requires (!std::invocable<F, X...>)

esphome::TemplatableValue< T, X >::TemplatableValue ( F value )

inline

Definition at line 59 of file automation.h.

TemplatableValue() [4/7]

template<typename T , typename... X>

template<typename F >
requires std::invocable<F, X...> && std::convertible_to<F, T (*)(X...)>

esphome::TemplatableValue< T, X >::TemplatableValue ( F f )

inline

Definition at line 69 of file automation.h.

TemplatableValue() [5/7]

template<typename T , typename... X>

template<typename F >
requires std::invocable<F, X...> &&(!std::convertible_to<F, T (*)(X...)>)

esphome::TemplatableValue< T, X >::TemplatableValue ( F f )

inline

Definition at line 76 of file automation.h.

TemplatableValue() [6/7]

template<typename T , typename... X>

esphome::TemplatableValue< T, X >::TemplatableValue ( const TemplatableValue< T, X > & other )

inline

Definition at line 81 of file automation.h.

TemplatableValue() [7/7]

template<typename T , typename... X>

esphome::TemplatableValue< T, X >::TemplatableValue ( TemplatableValue< T, X > && other )

inlinenoexcept

Definition at line 98 of file automation.h.

~TemplatableValue()

template<typename T , typename... X>

esphome::TemplatableValue< T, X >::~TemplatableValue ( )

inline

Definition at line 134 of file automation.h.

Member Function Documentation

get_static_string()

template<typename T , typename... X>

const char * esphome::TemplatableValue< T, X >::get_static_string ( ) const

inline

Get the static string pointer (only valid if is_static_string() returns true)

Definition at line 192 of file automation.h.

has_value()

template<typename T , typename... X>

bool esphome::TemplatableValue< T, X >::has_value ( ) const

inline

Definition at line 147 of file automation.h.

is_empty()

template<typename T , typename... X>

bool esphome::TemplatableValue< T, X >::is_empty ( ) const

inline

Check if the string value is empty without allocating (for std::string specialization).

For NONE, returns true. For STATIC_STRING/VALUE, checks without allocation. For LAMBDA/STATELESS_LAMBDA, must call value() which may allocate.

Definition at line 197 of file automation.h.

is_static_string()

template<typename T , typename... X>

bool esphome::TemplatableValue< T, X >::is_static_string ( ) const

inline

Check if this holds a static string (const char* stored without allocation)

Definition at line 189 of file automation.h.

operator=() [1/2]

template<typename T , typename... X>

TemplatableValue & esphome::TemplatableValue< T, X >::operator= ( const TemplatableValue< T, X > & other )

inline

Definition at line 118 of file automation.h.

operator=() [2/2]

template<typename T , typename... X>

TemplatableValue & esphome::TemplatableValue< T, X >::operator= ( TemplatableValue< T, X > && other )

inlinenoexcept

Definition at line 126 of file automation.h.

optional_value()

template<typename T , typename... X>

optional< T > esphome::TemplatableValue< T, X >::optional_value ( X... x )

inline

Definition at line 174 of file automation.h.

ref_or_copy_to()

template<typename T , typename... X>

StringRef esphome::TemplatableValue< T, X >::ref_or_copy_to ( char * lambda_buf, size_t lambda_buf_size ) const

inline

Get a StringRef to the string value without heap allocation when possible.

For STATIC_STRING/VALUE, returns reference to existing data (no allocation). For LAMBDA/STATELESS_LAMBDA, calls value(), copies to provided buffer, returns ref to buffer.

Parameters

lambda_buf	Buffer used only for lambda case (must remain valid while StringRef is used).
lambda_buf_size	Size of the buffer.

Returns

StringRef pointing to the string data.

Definition at line 216 of file automation.h.

value()

template<typename T , typename... X>

T esphome::TemplatableValue< T, X >::value ( X... x ) const

inline

Definition at line 149 of file automation.h.

value_or()

template<typename T , typename... X>

T esphome::TemplatableValue< T, X >::value_or ( X... x, T default_value )

inline

Definition at line 181 of file automation.h.

Field Documentation

[union]

union { ... } esphome::TemplatableValue< T, X >

f_

template<typename T , typename... X>

std::function<T(X...)>* esphome::TemplatableValue< T, X >::f_

Definition at line 248 of file automation.h.

stateless_f_

template<typename T , typename... X>

T(* esphome::TemplatableValue< T, X >::stateless_f_) (X...)

Definition at line 249 of file automation.h.

static_str_

template<typename T , typename... X>

const char* esphome::TemplatableValue< T, X >::static_str_

Definition at line 250 of file automation.h.

[]

enum { ... } esphome::TemplatableValue< T, X >::type_

value_

template<typename T , typename... X>

ValueStorage esphome::TemplatableValue< T, X >::value_

Definition at line 247 of file automation.h.

---

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

• esphome/core/automation.h