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

//! Synchronous [`Read`] / [`Write`] interfaces.

use crate::error::Error;

/// Generic read trait similar to [`std::io::Read`].
///
/// The instances of [`Read`] are required to construct [`Receiver`] 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:
///
/// - [`StdIoReader`] for [`std::io::Read`]
/// - [`EmbeddedIoReader`] for [`embedded_io::Read`]
///
/// [`Receiver`]: crate::io::Receiver
/// [`StdIoReader`]: crate::io::StdIoReader
/// [`EmbeddedIoReader`]: crate::io::EmbeddedIoReader
pub trait Read<Err: Into<Error>> {
    /// Read the exact number of bytes required to fill buffer.
    ///
    /// Mimics the corresponding method from [`std::io::Read`].
    ///
    /// # Errors
    ///
    /// Returns generic error in case of I/O failure.
    fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Err>;
}

/// Generic write trait similar to [`std::io::Write`].
///
/// The instances of [`Write`] are required to construct [`Sender`] 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:
///
/// - [`StdIoWriter`] for [`std::io::Write`]
/// - [`EmbeddedIoWriter`] for [`embedded_io::Write`]
///
/// [`Sender`]: crate::io::Sender
/// [`StdIoWriter`]: crate::io::StdIoWriter
/// [`EmbeddedIoWriter`]: crate::io::EmbeddedIoWriter
pub trait Write<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(&mut self, buf: &[u8]) -> Result<(), Err>;

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