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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use crate::io::{Read, Write};

/// Adapter for [`std::io::Read`] that produces [`Read`].
///
/// # Examples
///
/// Construct a receiver from [`std::net::TcpStream`].
///
/// ```rust,no_run
/// # #[cfg(not(feature = "std"))]
/// # fn main() {}
/// # #[cfg(feature = "std")]
/// # fn main() -> mavio::error::Result<()> {
/// use std::net::TcpStream;
/// use mavio::prelude::*;
///
/// // Create a TCP client receiver
/// let reader = StdIoReader::new(TcpStream::connect("0.0.0.0:5600")?);
/// let mut receiver = Receiver::versionless(reader);
///
/// # Ok(())
/// # }
/// ```
pub struct StdIoReader<R: std::io::Read> {
    reader: R,
}

impl<R: std::io::Read> StdIoReader<R> {
    /// Wraps an instance of [`std::io::Read`].
    #[inline(always)]
    pub fn new(reader: R) -> Self {
        Self { reader }
    }

    /// Extracts an instance of [`std::io::Read`].
    ///
    /// # Examples
    ///
    /// Wrap [`std::net::TcpStream`] as reader and extract it later.
    ///
    /// ```rust,no_run
    /// # #[cfg(not(feature = "std"))]
    /// # fn main() {}
    /// # #[cfg(feature = "std")]
    /// # fn main() -> mavio::error::Result<()> {
    /// use std::net::TcpStream;
    /// use mavio::io::StdIoReader;
    ///
    /// // Create a TCP client receiver
    /// let wrapped_reader = StdIoReader::new(TcpStream::connect("0.0.0.0:5600")?);
    /// /* perform operations */
    /// let reader = wrapped_reader.extract();
    ///
    /// # Ok(())
    /// # }
    /// ```
    #[inline(always)]
    pub fn extract(self) -> R {
        self.reader
    }
}

impl<R: std::io::Read> From<R> for StdIoReader<R> {
    fn from(value: R) -> Self {
        Self::new(value)
    }
}

impl<R: std::io::Read> Read<std::io::Error> for StdIoReader<R> {
    #[inline(always)]
    fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), std::io::Error> {
        self.reader.read_exact(buf)
    }
}

/// Adapter for [`std::io::Write`] that produces [`Write`].
///
/// # Examples
///
/// Construct a sender from [`std::net::TcpStream`].
///
/// ```rust,no_run
/// # #[cfg(not(feature = "std"))]
/// # fn main() {}
/// # #[cfg(feature = "std")]
/// # fn main() -> mavio::error::Result<()> {
/// use std::net::TcpStream;
/// use mavio::prelude::*;
///
/// // Create a TCP client sender
/// let writer = StdIoWriter::new(TcpStream::connect("0.0.0.0:5600")?);
/// let mut sender = Sender::versionless(writer);
///
/// # Ok(())
/// # }
/// ```
pub struct StdIoWriter<W: std::io::Write> {
    writer: W,
}

impl<W: std::io::Write> StdIoWriter<W> {
    /// Wraps an instance of [`std::io::Write`].
    #[inline(always)]
    pub fn new(writer: W) -> Self {
        Self { writer }
    }

    /// Extracts an instance of [`std::io::Write`].
    ///
    /// # Examples
    ///
    /// Wrap [`std::net::TcpStream`] as writer and extract it later.
    ///
    /// ```rust,no_run
    /// # #[cfg(not(feature = "std"))]
    /// # fn main() {}
    /// # #[cfg(feature = "std")]
    /// # fn main() -> mavio::error::Result<()> {
    /// use std::net::TcpStream;
    /// use mavio::io::StdIoWriter;
    ///
    /// // Create a TCP client receiver
    /// let wrapped_writer = StdIoWriter::new(TcpStream::connect("0.0.0.0:5600")?);
    /// /* perform operations */
    /// let writer = wrapped_writer.extract();
    ///
    /// # Ok(())
    /// # }
    /// ```
    #[inline(always)]
    pub fn extract(self) -> W {
        self.writer
    }
}

impl<W: std::io::Write> From<W> for StdIoWriter<W> {
    fn from(value: W) -> Self {
        Self::new(value)
    }
}

impl<W: std::io::Write> Write<std::io::Error> for StdIoWriter<W> {
    #[inline(always)]
    fn write_all(&mut self, buf: &[u8]) -> Result<(), std::io::Error> {
        self.writer.write_all(buf)
    }

    #[inline]
    fn flush(&mut self) -> Result<(), std::io::Error> {
        self.writer.flush()
    }
}