Trait Link

pub trait Link: Send {
    // Required methods
    fn open(&mut self, geometry: &Geometry) -> Result<(), LinkError>;
    fn close(&mut self) -> Result<(), LinkError>;
    fn alloc_tx_buffer(&mut self) -> Result<Vec<TxMessage>, LinkError>;
    fn send(&mut self, tx: Vec<TxMessage>) -> Result<(), LinkError>;
    fn receive(&mut self, rx: &mut [RxMessage]) -> Result<(), LinkError>;
    fn is_open(&self) -> bool;
}

Available on crate feature link only.

A trait that provides the interface with the device.

Required Methods

fn open(&mut self, geometry: &Geometry) -> Result<(), LinkError>

Opens the link.

fn close(&mut self) -> Result<(), LinkError>

Closes the link.

fn alloc_tx_buffer(&mut self) -> Result<Vec<TxMessage>, LinkError>

Allocate a sending buffer for the link.

fn send(&mut self, tx: Vec<TxMessage>) -> Result<(), LinkError>

Sends a message to the device.

fn receive(&mut self, rx: &mut [RxMessage]) -> Result<(), LinkError>

Receives a message from the device.

fn is_open(&self) -> bool

Checks if the link is open.

Trait Implementations

impl Link for Box<dyn Link>

fn open(&mut self, geometry: &Geometry) -> Result<(), LinkError>

Opens the link.

fn close(&mut self) -> Result<(), LinkError>

Closes the link.

fn alloc_tx_buffer(&mut self) -> Result<Vec<TxMessage>, LinkError>

Allocate a sending buffer for the link.

fn send(&mut self, tx: Vec<TxMessage>) -> Result<(), LinkError>

Sends a message to the device.

fn receive(&mut self, rx: &mut [RxMessage]) -> Result<(), LinkError>

Receives a message from the device.

fn is_open(&self) -> bool

Checks if the link is open.

Implementations on Foreign Types

impl Link for Box<dyn Link>

fn open(&mut self, geometry: &Geometry) -> Result<(), LinkError>

fn close(&mut self) -> Result<(), LinkError>

fn alloc_tx_buffer(&mut self) -> Result<Vec<TxMessage>, LinkError>

fn send(&mut self, tx: Vec<TxMessage>) -> Result<(), LinkError>

fn receive(&mut self, rx: &mut [RxMessage]) -> Result<(), LinkError>

fn is_open(&self) -> bool

Implementors