Struct esp_idf_sys::esp_console_cmd_t

#[repr(C)]
pub struct esp_console_cmd_t {
    pub command: *const c_char,
    pub help: *const c_char,
    pub hint: *const c_char,
    pub func: esp_console_cmd_func_t,
    pub argtable: *mut c_void,
}

@brief Console command description

Fields

command: *const c_char

Command name. Must not be NULL, must not contain spaces. The pointer must be valid until the call to esp_console_deinit.

help: *const c_char

Help text for the command, shown by help command. If set, the pointer must be valid until the call to esp_console_deinit. If not set, the command will not be listed in ‘help’ output.

hint: *const c_char

Hint text, usually lists possible arguments. If set to NULL, and ‘argtable’ field is non-NULL, hint will be generated automatically

func: esp_console_cmd_func_t

Pointer to a function which implements the command.

argtable: *mut c_void

Array or structure of pointers to arg_xxx structures, may be NULL. Used to generate hint text if ‘hint’ is set to NULL. Array/structure which this field points to must end with an arg_end. Only used for the duration of esp_console_cmd_register call.

Trait Implementations

impl Clone for esp_console_cmd_t

fn clone(&self) -> esp_console_cmd_t

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for esp_console_cmd_t

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for esp_console_cmd_t

fn default() -> Self

Returns the “default value” for a type.

impl Copy for esp_console_cmd_t