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

/// <sup>`⚠`</sup>
/// A trait, that updates internal state of a type using an instance of another type.
pub trait TryUpdateFrom<T> {
    /// Error, that may be thrown during update.
    type Error;

    /// <sup>`⚠`</sup>
    /// Performs the update.
    ///
    /// **⚠** If you are going to reimplement the blanket implementation, then it is mandatory, that
    /// all checks related to the possibility of update should be performed before the update.
    ///
    /// Returns [`Self::Error`], when update is impossible.
    fn try_update_from(&mut self, value: T) -> Result<(), Self::Error> {
        self.check_try_update_from(&value)?;
        unsafe {
            self.update_from_unchecked(value);
        }
        Ok(())
    }

    /// <sup>`⚠`</sup>
    /// Checks, that update is possible.
    ///
    /// Returns [`Self::Error`], when update is impossible.
    fn check_try_update_from(&self, value: &T) -> Result<(), Self::Error>;

    /// <sup>`⚠`</sup>
    /// Performs the update without checking, whether update is possible.
    ///
    /// **⚠** This method should not be used directly. Use [`Self::try_update_from`] instead.
    ///
    /// # Panics
    ///
    /// This method should panic, when update is not possible. It is marked as `unsafe` since
    /// Rust type system can't guarantee, that the contract will be fulfilled by implementor.
    unsafe fn update_from_unchecked(&mut self, value: T);
}