maviola 0.3.0

High-level MAVLink communication library with support for essential micro-services.
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

//! # Busy reader and writer
//!
//! Implementation for [`Read`] and [`Write`] that always returns [`ErrorKind::TimedOut`].

use std::io::{Error, ErrorKind, Read, Write};

/// <sup>`⍚` | [`sync`](crate::sync)</sup>
/// Reader that always returns a time-out error.
///
/// This reader always returns time-out I/O error for any read attempt. It is useful for creating
/// uni-directional reader / writer pairs. For example, a file writer should newer read and vice
/// versa.
///
/// The writer counterpart is [`BusyWriter`].
pub struct BusyReader;

impl Read for BusyReader {
    /// Always returns an error.
    ///
    /// # Errors
    ///
    /// Returns [`ErrorKind::TimedOut`] for all reading attempts.
    fn read(&mut self, _: &mut [u8]) -> std::io::Result<usize> {
        Err(Error::new(
            ErrorKind::TimedOut,
            "attempt to read from BusyReader",
        ))
    }

    /// Always returns an error.
    ///
    /// # Errors
    ///
    /// Returns [`ErrorKind::TimedOut`] for all reading attempts.
    fn read_exact(&mut self, _: &mut [u8]) -> std::io::Result<()> {
        Err(Error::new(
            ErrorKind::TimedOut,
            "attempt to read from BusyReader",
        ))
    }
}

/// <sup>`⍚` | [`sync`](crate::sync)</sup>
/// Writer that always returns a time-out error.
///
/// This writer always returns time-out I/O error for any write attempt. It is useful for creating
/// uni-directional reader / writer pairs. For example, a file reader should newer read and vice
/// versa.
///
/// The reader counterpart is [`BusyReader`].
pub struct BusyWriter;

impl Write for BusyWriter {
    /// Always returns a timed-out error.
    ///
    /// # Errors
    ///
    /// Returns [`ErrorKind::TimedOut`] for all writing attempts.
    fn write(&mut self, _: &[u8]) -> std::io::Result<usize> {
        Err(Error::new(
            ErrorKind::TimedOut,
            "attempt to write to BusyWriter",
        ))
    }

    /// Flush this output stream, ensuring that all intermediately buffered contents reach their destination.
    ///
    /// Always returns [`Ok`] since [`BusyWriter`] never actually writes.
    fn flush(&mut self) -> std::io::Result<()> {
        Ok(())
    }

    fn by_ref(&mut self) -> &mut Self
    where
        Self: Sized,
    {
        self
    }
}