moddef-cpp
Idiomatic C++ runtime for ModDef
Loading...
Searching...
No Matches
moddef::CommandParams< N > Class Template Reference

Fixed-capacity param set for CommandExecutor::begin. More...

#include <command.hpp>

Public Member Functions

bool value (std::string_view field, Value v)
 Numeric param (CommandParam.field -> md_value_t).
 
bool value (std::string_view field, std::int64_t v)
 
bool value (std::string_view field, double v)
 
bool str (std::string_view field, std::string_view s)
 STRING_ASCII / STRING_UTF8 param.
 
bool bytes (std::string_view field, std::span< const std::uint8_t > b)
 BYTES_RAW param.
 
const md_cmd_params_t * c_params () const noexcept
 
 CommandParams ()=default
 
 CommandParams (const CommandParams &)=delete
 
CommandParamsoperator= (const CommandParams &)=delete
 

Detailed Description

template<std::size_t N>
class moddef::CommandParams< N >

Fixed-capacity param set for CommandExecutor::begin.

Values reference caller storage (strings/bytes are not copied).

Constructor & Destructor Documentation

◆ CommandParams() [1/2]

template<std::size_t N>
moddef::CommandParams< N >::CommandParams ( )
default

◆ CommandParams() [2/2]

template<std::size_t N>
moddef::CommandParams< N >::CommandParams ( const CommandParams< N > &  )
delete

Member Function Documentation

◆ value() [1/3]

template<std::size_t N>
bool moddef::CommandParams< N >::value ( std::string_view  field,
Value  v 
)
inline

Numeric param (CommandParam.field -> md_value_t).

◆ value() [2/3]

template<std::size_t N>
bool moddef::CommandParams< N >::value ( std::string_view  field,
std::int64_t  v 
)
inline

◆ value() [3/3]

template<std::size_t N>
bool moddef::CommandParams< N >::value ( std::string_view  field,
double  v 
)
inline

◆ str()

template<std::size_t N>
bool moddef::CommandParams< N >::str ( std::string_view  field,
std::string_view  s 
)
inline

STRING_ASCII / STRING_UTF8 param.

◆ bytes()

template<std::size_t N>
bool moddef::CommandParams< N >::bytes ( std::string_view  field,
std::span< const std::uint8_t >  b 
)
inline

BYTES_RAW param.

◆ c_params()

template<std::size_t N>
const md_cmd_params_t * moddef::CommandParams< N >::c_params ( ) const
inlinenoexcept

◆ operator=()

template<std::size_t N>
CommandParams & moddef::CommandParams< N >::operator= ( const CommandParams< N > &  )
delete

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