Struct esp_idf_svc::hal::sys::esp_console_cmd_t

source ·
#[repr(C)]
pub struct esp_console_cmd_t { pub command: *const i8, pub help: *const i8, pub hint: *const i8, pub func: Option<unsafe extern "C" fn(_: i32, _: *mut *mut i8) -> i32>, pub argtable: *mut c_void, }
Expand description

@brief Console command description

Fields§

§command: *const i8

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

§help: *const i8

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 i8

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

§func: Option<unsafe extern "C" fn(_: i32, _: *mut *mut i8) -> i32>

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§

source§

impl Clone for esp_console_cmd_t

source§

fn clone(&self) -> esp_console_cmd_t

Returns a copy of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
source§

impl Debug for esp_console_cmd_t

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for esp_console_cmd_t

source§

fn default() -> esp_console_cmd_t

Returns the “default value” for a type. Read more
source§

impl Copy for esp_console_cmd_t

Auto Trait Implementations§

§

impl Freeze for esp_console_cmd_t

§

impl RefUnwindSafe for esp_console_cmd_t

§

impl !Send for esp_console_cmd_t

§

impl !Sync for esp_console_cmd_t

§

impl Unpin for esp_console_cmd_t

§

impl UnwindSafe for esp_console_cmd_t

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CloneToUninit for T
where T: Copy,

§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.