mavio 0.5.10

Minimalistic MAVLink client that supports `no-std` and `no-alloc` targets.
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
63

//! Asynchronous [`AsyncRead`] / [`AsyncWrite`] interfaces.

use core::future::Future;

use crate::error::Error;

/// Generic asynchronous read trait similar to [`std::io::Read`].
///
/// The instances of [`AsyncRead`] are required to construct [`AsyncReceiver`] that can read
/// MavLink frames.
///
/// Instead of relying on a particular definition of read trait, we allow users to use any library
/// with I/O capabilities.
///
/// Wrappers are available for specific I/O implementations:
///
/// - [`TokioReader`] for [`tokio::io::AsyncRead`]
/// - [`EmbeddedIoAsyncReader`] for [`embedded_io_async::Read`]
///
/// [`AsyncReceiver`]: crate::io::AsyncReceiver
/// [`TokioReader`]: crate::io::TokioReader
/// [`EmbeddedIoAsyncReader`]: crate::io::EmbeddedIoAsyncReader
pub trait AsyncRead<Err: Into<Error>> {
    /// Reads asynchronously the exact number of bytes required to fill the buffer.
    ///
    /// Mimics the corresponding method from [`std::io::Read`].
    ///
    /// # Errors
    ///
    /// Returns generic error in case of I/O failure.
    fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> impl Future<Output = Result<(), Err>>;
}

/// Generic asynchronous write trait similar to [`std::io::Write`].
///
/// The instances of [`AsyncWrite`] are required to construct [`AsyncSender`] that can write
/// MavLink frames.
///
/// Instead of relying on a particular definition of write trait, we allow users to use any library
/// with I/O capabilities.
///
/// Wrappers are available for specific I/O implementations:
///
/// - [`TokioWriter`] for [`tokio::io::AsyncWrite`]
/// - [`EmbeddedIoAsyncWriter`] for [`embedded_io_async::Write`]
///
/// [`AsyncSender`]: crate::io::AsyncSender
/// [`TokioWriter`]: crate::io::TokioWriter
/// [`EmbeddedIoAsyncWriter`]: crate::io::EmbeddedIoAsyncWriter
pub trait AsyncWrite<Err: Into<Error>> {
    /// Attempts to write an entire buffer into this writer.
    ///
    /// Mimics the corresponding method from [`std::io::Write`].
    ///
    /// # Errors
    ///
    /// Returns generic error in case of I/O failure.
    fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> impl Future<Output = Result<(), Err>>;

    /// Flush this output stream, ensuring that all intermediately buffered
    /// contents reach their destination.
    fn flush(&mut self) -> impl Future<Output = Result<(), Err>>;
}