Trait endbasic_core::exec::BuiltinCommand

pub trait BuiltinCommand {
    pub fn name(&self) -> &'static str;
    pub fn syntax(&self) -> &'static str;
    pub fn description(&self) -> &'static str;
#[must_use]    pub fn exec<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        args: &'life1 [(Option<Expr>, ArgSep)], 
        machine: &'life2 mut Machine
    ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;
}

A trait to define a command that is executed by a Machine.

The commands themselves are immutable but they can reference mutable state. Given that EndBASIC is not threaded, it is sufficient for those references to be behind a RefCell and/or an Rc.

Required methods

pub fn name(&self) -> &'static str

Returns the name of the command, all in uppercase letters.

pub fn syntax(&self) -> &'static str

Returns a specification of the command's syntax.

pub fn description(&self) -> &'static str

Returns the usage message of the command.

#[must_use]pub fn exec<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    args: &'life1 [(Option<Expr>, ArgSep)],
    machine: &'life2 mut Machine
) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Executes the command.

args contains the arguments as provided in the invocation of the command. Each entry in this array contains an optional expression (to support things like PRINT a, , b) and the separator that was used between that argument and the next. The last entry in args always has ArgSep::End as the separator.

machine provides mutable access to the current state of the machine invoking the command.

Commands cannot return any value except for errors.

Loading content...

Implementors

impl BuiltinCommand for ClsCommand

pub fn name(&self) -> &'static str

pub fn syntax(&self) -> &'static str

pub fn description(&self) -> &'static str

pub fn exec<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    args: &'life1 [(Option<Expr>, ArgSep)],
    _machine: &'life2 mut Machine
) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

impl BuiltinCommand for ColorCommand

pub fn name(&self) -> &'static str

pub fn syntax(&self) -> &'static str

pub fn description(&self) -> &'static str

pub fn exec<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    args: &'life1 [(Option<Expr>, ArgSep)],
    machine: &'life2 mut Machine
) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

impl BuiltinCommand for InputCommand

pub fn name(&self) -> &'static str

pub fn syntax(&self) -> &'static str

pub fn description(&self) -> &'static str

pub fn exec<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    args: &'life1 [(Option<Expr>, ArgSep)],
    machine: &'life2 mut Machine
) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

impl BuiltinCommand for LocateCommand

pub fn name(&self) -> &'static str

pub fn syntax(&self) -> &'static str

pub fn description(&self) -> &'static str

pub fn exec<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    args: &'life1 [(Option<Expr>, ArgSep)],
    machine: &'life2 mut Machine
) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

impl BuiltinCommand for PrintCommand

pub fn name(&self) -> &'static str

pub fn syntax(&self) -> &'static str

pub fn description(&self) -> &'static str

pub fn exec<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    args: &'life1 [(Option<Expr>, ArgSep)],
    machine: &'life2 mut Machine
) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

impl BuiltinCommand for ClearCommand

pub fn name(&self) -> &'static str

pub fn syntax(&self) -> &'static str

pub fn description(&self) -> &'static str

pub fn exec<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    args: &'life1 [(Option<Expr>, ArgSep)],
    machine: &'life2 mut Machine
) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

impl BuiltinCommand for HelpCommand

pub fn name(&self) -> &'static str

pub fn syntax(&self) -> &'static str

pub fn description(&self) -> &'static str

pub fn exec<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    args: &'life1 [(Option<Expr>, ArgSep)],
    machine: &'life2 mut Machine
) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

impl BuiltinCommand for ExitCommand

pub fn name(&self) -> &'static str

pub fn syntax(&self) -> &'static str

pub fn description(&self) -> &'static str

pub fn exec<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    args: &'life1 [(Option<Expr>, ArgSep)],
    machine: &'life2 mut Machine
) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Loading content...