Enum scpi::tree::Node

pub enum Node<'a, D> {
    Leaf {
        name: &'static [u8],
        default: bool,
        handler: &'a dyn Command<D>,
    },
    Branch {
        name: &'static [u8],
        default: bool,
        sub: &'a [Node<'a, D>],
    },
}

A SCPI command node These nodes are structured as a command tree where each node represent a SCPI header mnemonic.

Variants

Leaf

A leaf node which can be called or queried.

Fields

name: &'static [u8]

Mnemonic of this leaf

default: bool

Default node, will be executed if the branch immediately below is executed. Only one default node is allowed in each branch.

handler: &'a dyn Command<D>

Command handler

Branch

A branch which contains one or more leaves.

Fields

name: &'static [u8]

Mnemonic of this branch

default: bool

Default node.

sub: &'a [Node<'a, D>]

Child nodes Note: Default node must be first!

Implementations

impl<'a, D> Node<'a, D>

pub const fn leaf(name: &'static [u8], handler: &'a dyn Command<D>) -> Self

Create a leaf node

Alternatively use crate::Leaf!

pub const fn default_leaf( name: &'static [u8], handler: &'a dyn Command<D> ) -> Self

Create a default leaf node

Alternatively use crate::Leaf!

pub const fn branch(name: &'static [u8], sub: &'a [Node<'a, D>]) -> Self

Create a branch node

Alternatively use crate::Branch!

pub const fn default_branch(name: &'static [u8], sub: &'a [Node<'a, D>]) -> Self

Create a default branch node

Alternatively use crate::Branch!

pub const fn root(sub: &'a [Node<'a, D>]) -> Self

Create a root node

Alternatively use crate::Root!

impl<'a, D> Node<'a, D>

pub fn name(&self) -> &'static [u8]

impl<'a, D> Node<'a, D>

where D: Device,

pub fn run<FMT>( &self, command: &[u8], device: &mut D, context: &mut Context<'_>, response: &mut FMT ) -> Result<()>

where FMT: Formatter,

Execute a command against a given device.

Arguments:

• command - To be executed
• device - To execute against
• context - Context for this command
• response - A formatter to write a response into.