noterm 0.2.3

noterm, a no_std terminal handler.
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
56
57
58
59
60
61
62

#![allow(async_fn_in_trait)]

use core::fmt::Debug;

pub mod blocking;

/// Error.
#[derive(Debug, PartialEq, Eq, Hash, thiserror::Error)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum Error {
    /// Unknown error.
    #[error("unknown error")]
    Unknown,
}

pub type Result<T, E = Error> = core::result::Result<T, E>;

/// Reader trait.
pub trait Read {
    async fn read(&mut self, data: &mut [u8]) -> Result<usize>;

    async fn read_all(&mut self, mut data: &mut [u8]) -> Result<()> {
        while !data.is_empty() {
            let count = self.read(data).await?;
            data = &mut data[count..];
        }
        Ok(())
    }
}

impl<ReaderTy: Read> Read for &mut ReaderTy {
    #[inline]
    async fn read(&mut self, data: &mut [u8]) -> Result<usize> {
        ReaderTy::read(*self, data).await
    }
}

/// Writer trait.
pub trait Write {
    async fn write(&mut self, data: &[u8]) -> Result<usize>;
    async fn flush(&mut self) -> Result<()>;

    async fn write_all(&mut self, mut data: &[u8]) -> Result<()> {
        while !data.is_empty() {
            let count = self.write(data).await?;
            data = &data[count..];
        }
        Ok(())
    }
}

impl<WriterTy: Write> Write for &mut WriterTy {
    #[inline]
    async fn write(&mut self, data: &[u8]) -> Result<usize> {
        WriterTy::write(*self, data).await
    }

    #[inline]
    async fn flush(&mut self) -> Result<()> {
        WriterTy::flush(*self).await
    }
}