ashv2 10.0.1

Implementation of the Asynchronous Serial Host (ASH) protocol.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

use std::io;

use log::trace;
use tokio::sync::mpsc::Sender;
use tokio::sync::mpsc::error::SendError;
use tokio::sync::oneshot::channel;

use crate::Payload;
use crate::actor::message::Message;
use crate::hex_slice::HexSlice;

/// User-facing handle for sending payloads to the `ASHv2` actor.
#[derive(Clone, Debug)]
pub struct Handle {
    inner: Sender<Message>,
}

impl Handle {
    /// Send data to the `ASHv2` actor.
    ///
    /// # Errors
    ///
    /// Returns an error if the actor futures are no longer accepting messages or if the
    /// transmitter fails to write the payload.
    pub async fn send(&self, payload: Payload) -> io::Result<()> {
        let (response_tx, response_rx) = channel();

        trace!("Sending chunk: {:#04X}", HexSlice::new(&payload));
        self.inner
            .send(Message::Payload {
                payload: Box::new(payload),
                response_tx,
            })
            .await
            .map_err(io::Error::other)?;

        response_rx.await.map_err(io::Error::other)?
    }

    /// Request actor termination.
    ///
    /// # Errors
    ///
    /// Returns [`SendError`] if sending the termination message to the transmitter fails.
    pub async fn terminate(&self) -> Result<(), SendError<Message>> {
        self.inner.send(Message::Terminate).await?;
        Ok(())
    }
}

impl From<Sender<Message>> for Handle {
    fn from(inner: Sender<Message>) -> Self {
        Self { inner }
    }
}