Trait CommandTrait

pub trait CommandTrait: 'static {
    // Required methods
    fn name(&self) -> Name;
    fn inputs(&self) -> Vec<CmdInputDescription>;
    fn outputs(&self) -> Vec<CmdOutputDescription>;
    fn run<'life0, 'async_trait>(
        &'life0 self,
        ctx: CommandContext,
        params: ValueSet,
    ) -> Pin<Box<dyn Future<Output = Result<ValueSet, CommandError>> + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

    // Provided methods
    fn instruction_info(&self) -> Option<InstructionInfo> { ... }
    fn permissions(&self) -> Permissions { ... }
    fn destroy<'life0, 'async_trait>(
        &'life0 mut self,
    ) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn read_form_data(&self, data: Value) -> ValueSet { ... }
    fn passthrough_outputs(&self, inputs: &ValueSet) -> ValueSet { ... }
    fn input_is_required(&self, name: &str) -> Option<bool> { ... }
    fn output_is_optional(&self, name: &str) -> Option<bool> { ... }
}

Generic trait for implementing commands.

Required Methods

fn name(&self) -> Name

Unique name to identify the command.

fn inputs(&self) -> Vec<CmdInputDescription>

List of inputs that the command can receive.

fn outputs(&self) -> Vec<CmdOutputDescription>

List of outputs that the command will return.

fn run<'life0, 'async_trait>( &'life0 self, ctx: CommandContext, params: ValueSet, ) -> Pin<Box<dyn Future<Output = Result<ValueSet, CommandError>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Run the command.

Provided Methods

fn instruction_info(&self) -> Option<InstructionInfo>

Specify if and how would this command output Solana instructions.

fn permissions(&self) -> Permissions

Specify requested permissions of this command.

fn destroy<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Async Drop method.

fn read_form_data(&self, data: Value) -> ValueSet

Specify how form_data are read.

fn passthrough_outputs(&self, inputs: &ValueSet) -> ValueSet

Specify how to convert inputs into passthrough outputs.

fn input_is_required(&self, name: &str) -> Option<bool>

fn output_is_optional(&self, name: &str) -> Option<bool>

Implementors