Trait AtContext 

pub trait AtContext<const SIZE: usize> {
    // Provided methods
    fn exec(&self) -> AtResult<SIZE> { ... }
    fn query(&mut self) -> AtResult<SIZE> { ... }
    fn test(&mut self) -> AtResult<SIZE> { ... }
    fn set(&mut self, _args: Args<'_>) -> AtResult<SIZE> { ... }
}

Trait that defines the context for AT command execution. Implementations of this trait handle the actual logic for each AT command form.

The const generic SIZE defines the size (in bytes) of the response buffer returned by command handlers.

Provided Methods

fn exec(&self) -> AtResult<SIZE>

Execute command (AT+CMD) This is called when a command is invoked without any suffix.

Examples found in repository

examples/complete_usage.rs (line 178)

fn execute_command(cmd: &str, name: &str, module: &mut dyn AtContext<SIZE>) {
    let result = if let Some(rest) = cmd.strip_prefix(name) {
        if rest.is_empty() {
            module.exec()
        } else if rest == "?" {
            module.query()
        } else if rest == "=?" {
            module.test()
        } else if let Some(args_str) = rest.strip_prefix('=') {
            module.set(Args { raw: args_str })
        } else {
            Err(AtError::InvalidArgs)
        }
    } else {
        Err(AtError::UnknownCommand)
    };
    let _ = result;
}

fn query(&mut self) -> AtResult<SIZE>

Query command (AT+CMD?) This is called to retrieve the current value/state of a command.

Examples found in repository

examples/complete_usage.rs (line 180)

fn execute_command(cmd: &str, name: &str, module: &mut dyn AtContext<SIZE>) {
    let result = if let Some(rest) = cmd.strip_prefix(name) {
        if rest.is_empty() {
            module.exec()
        } else if rest == "?" {
            module.query()
        } else if rest == "=?" {
            module.test()
        } else if let Some(args_str) = rest.strip_prefix('=') {
            module.set(Args { raw: args_str })
        } else {
            Err(AtError::InvalidArgs)
        }
    } else {
        Err(AtError::UnknownCommand)
    };
    let _ = result;
}

fn test(&mut self) -> AtResult<SIZE>

Test command (AT+CMD=?) This is called to check if a command is supported or to get valid parameter ranges.

Examples found in repository

examples/complete_usage.rs (line 182)

fn execute_command(cmd: &str, name: &str, module: &mut dyn AtContext<SIZE>) {
    let result = if let Some(rest) = cmd.strip_prefix(name) {
        if rest.is_empty() {
            module.exec()
        } else if rest == "?" {
            module.query()
        } else if rest == "=?" {
            module.test()
        } else if let Some(args_str) = rest.strip_prefix('=') {
            module.set(Args { raw: args_str })
        } else {
            Err(AtError::InvalidArgs)
        }
    } else {
        Err(AtError::UnknownCommand)
    };
    let _ = result;
}

fn set(&mut self, _args: Args<'_>) -> AtResult<SIZE>

Set command (AT+CMD=args) This is called to set parameters for a command.

Examples found in repository

examples/complete_usage.rs (line 184)

fn execute_command(cmd: &str, name: &str, module: &mut dyn AtContext<SIZE>) {
    let result = if let Some(rest) = cmd.strip_prefix(name) {
        if rest.is_empty() {
            module.exec()
        } else if rest == "?" {
            module.query()
        } else if rest == "=?" {
            module.test()
        } else if let Some(args_str) = rest.strip_prefix('=') {
            module.set(Args { raw: args_str })
        } else {
            Err(AtError::InvalidArgs)
        }
    } else {
        Err(AtError::UnknownCommand)
    };
    let _ = result;
}

Implementors