Struct CuMspBridge 

pub struct CuMspBridge<S, E>
where
    S: Write<Error = E> + Read<Error = E> + Send + Sync + 'static,
    E: 'static,
{ /* private fields */ }

Bridge that multiplexes MSP traffic on a single serial link.

Trait Implementations

impl<S, E> CuBridge for CuMspBridge<S, E>

where S: Write<Error = E> + Read<Error = E> + Send + Sync + 'static, E: 'static,

type Resources<'r> = MspResources<S>

Resources required by the bridge.

type Tx = TxChannels

Outgoing channels (Copper -> external world).

type Rx = RxChannels

Incoming channels (external world -> Copper).

fn new( config: Option<&ComponentConfig>, tx_channels: &[BridgeChannelConfig<<Self::Tx as BridgeChannelSet>::Id>], rx_channels: &[BridgeChannelConfig<<Self::Rx as BridgeChannelSet>::Id>], resources: Self::Resources<'_>, ) -> CuResult<Self>

where Self: Sized,

Constructs a new bridge.

fn preprocess(&mut self, _clock: &RobotClock) -> CuResult<()>

Gives the bridge a chance to prepare buffers before I/O.

fn send<'a, Payload>( &mut self, _clock: &RobotClock, channel: &'static BridgeChannel<<Self::Tx as BridgeChannelSet>::Id, Payload>, msg: &CuMsg<Payload>, ) -> CuResult<()>

where Payload: CuMsgPayload + 'a,

Sends a message on the selected outbound channel.

fn receive<'a, Payload>( &mut self, clock: &RobotClock, channel: &'static BridgeChannel<<Self::Rx as BridgeChannelSet>::Id, Payload>, msg: &mut CuMsg<Payload>, ) -> CuResult<()>

where Payload: CuMsgPayload + 'a,

Receives a message from the selected inbound channel.

fn start(&mut self, _clock: &RobotClock) -> Result<(), CuError>

Called before the first send/receive cycle.

fn postprocess(&mut self, _clock: &RobotClock) -> Result<(), CuError>

Called once the send/receive pair completed.

fn stop(&mut self, _clock: &RobotClock) -> Result<(), CuError>

Notifies the bridge that no more I/O will happen until a subsequent [start].

impl<S, E> Freezable for CuMspBridge<S, E>

where S: Write<Error = E> + Read<Error = E> + Send + Sync + 'static, E: 'static,

fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>

where E: Encoder,

This method is called by the framework when it wants to save the task state. The default implementation is to encode nothing (stateless). If you have a state, you need to implement this method.

fn thaw<D>(&mut self, _decoder: &mut D) -> Result<(), DecodeError>

where D: Decoder,

This method is called by the framework when it wants to restore the task to a specific state. Here it is similar to Decode but the framework will give you a new instance of the task (the new method will be called)

impl<S, E> TypePath for CuMspBridge<S, E>

where S: Write<Error = E> + Read<Error = E> + Send + Sync + 'static, E: 'static,

fn type_path() -> &'static str

fn short_type_path() -> &'static str

fn type_ident() -> Option<&'static str>

fn crate_name() -> Option<&'static str>

fn module_path() -> Option<&'static str>