Trait new_home_application::method::Method

pub trait Method {
    fn name(&self) -> String;
    fn description(&self) -> String;
    fn help(&self) -> String;
}

This trait is used for providing basic information about a method struct This can be derived using the derive macro from the new_home_application_macro crate.

Required methods

fn name(&self) -> String

This method provides a name for the method. It is used to identify the method when its called

When using the derive macro the value returned here is a snake_case version of the struct name.

fn description(&self) -> String

Returns a couple words as a description for the method. For more detailed "helpful" info use the help method.

When derived, this field will be filled from the #description attribute

fn help(&self) -> String

This provides a more detailed overview up to a help for what the method does, and when it does things.

When derived, this field will be filled from the #help attribute

Loading content...

Implementors

Loading content...