mavinspect 0.6.6

Library for parsing MAVLink XML definitions
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

//! Metadata for MAVLink dialects.
//!
//! Upon reading from a location that contains MAVlink XML definitions, [`Inspector`](crate::Inspector)
//! looks up for a file `.dialects-metadata.yml`. If it exists, it loads its contents into a
//! [`MavInspectMetadata`](crate::parser::MavInspectMetadata) and attaches [`DialectMetadata`]
//! to all top-level dialects loaded from this location (includes are ignored).

/// Metadata for MAVLink dialect.
///
/// Upon reading from a location that contains MAVlink XML definitions, [`Inspector`](crate::Inspector)
/// looks up for a file `.dialects-metadata.yml`. If it exists, it loads its contents into
/// [`MavInspectMetadata`](crate::parser::MavInspectMetadata) and attaches metadata to all
/// top-level dialects loaded from this location (includes are ignored).
#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
#[cfg_attr(feature = "specta", derive(specta::Type))]
pub struct DialectMetadata {
    pub(crate) tags: DialectTags,
}

/// Collection of tags used in [`DialectMetadata`].
#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
#[cfg_attr(feature = "specta", derive(specta::Type))]
pub struct DialectTags(Vec<String>);

impl DialectTags {
    /// Constructor.
    pub fn new(tags: &[impl AsRef<str>]) -> Self {
        let tags = tags
            .iter()
            .map(|t| t.as_ref().to_string())
            .collect::<Vec<_>>();
        Self(tags)
    }

    /// Returns all tags.
    pub fn tags(&self) -> &[String] {
        self.0.as_slice()
    }

    /// Returns `true` if there are no tags in collection.
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Returns `true` if metadata contains a specified `tag`.
    pub fn contains(&self, tag: impl AsRef<str>) -> bool {
        self.0.iter().any(|t| t == tag.as_ref())
    }

    /// Returns `true` if one of tags are present.
    pub fn has_one_of(&self, tags: &Self) -> bool {
        for present in self.0.iter() {
            for requested in tags.0.iter() {
                if present == requested {
                    return true;
                }
            }
        }

        false
    }

    /// Extends tags with the provided list.
    pub fn extend(&mut self, tags: &DialectTags) {
        for tag in tags.0.iter() {
            if !self.0.contains(&tag) {
                self.0.push(tag.to_string());
            }
        }
    }
}

impl DialectMetadata {
    /// Returns all tags.
    #[inline(always)]
    pub fn tags(&self) -> &[String] {
        self.tags.tags()
    }

    /// Returns `true` if metadata contains a specified `tag`.
    #[inline(always)]
    pub fn has_tag(&self, tag: impl AsRef<str>) -> bool {
        self.tags.contains(tag)
    }

    /// Returns `true` if one of tags are present.
    #[inline(always)]
    pub fn has_one_of_tags(&self, tags: &DialectTags) -> bool {
        self.tags.has_one_of(tags)
    }
}