open62541 0.6.2

High-level, safe bindings for the C99 library open62541, an open source and free implementation of OPC UA (OPC Unified Architecture).
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

// We do not expose the inner enum. We want to use a proper `u32` for bit operations on the mask and
// we want to be clear about what is an initial (const, enum-like) value and what is a derived mask;
// specifically, the bitmask type is _not_ an enum even though declared so in `open62541-sys`.
#[allow(unreachable_pub)]
mod inner {
    crate::data_type!(BrowseResultMask);

    crate::enum_variants!(
        BrowseResultMask,
        UA_BrowseResultMask,
        [
            NONE,
            REFERENCETYPEID,
            ISFORWARD,
            NODECLASS,
            BROWSENAME,
            DISPLAYNAME,
            TYPEDEFINITION,
            ALL,
            REFERENCETYPEINFO,
            TARGETINFO,
        ],
    );
}

/// Wrapper for browse result mask from [`open62541_sys`].
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct BrowseResultMask(u32);

crate::bitmask_ops!(BrowseResultMask);

impl BrowseResultMask {
    pub const NONE: Self = Self(inner::BrowseResultMask::NONE_U32);
    pub const REFERENCETYPEID: Self = Self(inner::BrowseResultMask::REFERENCETYPEID_U32);
    pub const ISFORWARD: Self = Self(inner::BrowseResultMask::ISFORWARD_U32);
    pub const NODECLASS: Self = Self(inner::BrowseResultMask::NODECLASS_U32);
    pub const BROWSENAME: Self = Self(inner::BrowseResultMask::BROWSENAME_U32);
    pub const DISPLAYNAME: Self = Self(inner::BrowseResultMask::DISPLAYNAME_U32);
    pub const TYPEDEFINITION: Self = Self(inner::BrowseResultMask::TYPEDEFINITION_U32);
    pub const ALL: Self = Self(inner::BrowseResultMask::ALL_U32);
    pub const REFERENCETYPEINFO: Self = Self(inner::BrowseResultMask::REFERENCETYPEINFO_U32);
    pub const TARGETINFO: Self = Self(inner::BrowseResultMask::TARGETINFO_U32);

    pub(crate) const fn from_u32(mask: u32) -> Self {
        Self(mask)
    }

    pub(crate) const fn as_u32(&self) -> u32 {
        self.0
    }
}

#[cfg(test)]
mod tests {
    use crate::ua;

    #[test]
    fn combine_masks() {
        // We support mask combinators in `const` expressions.
        const LHS: ua::BrowseResultMask =
            ua::BrowseResultMask::REFERENCETYPEID.or(&ua::BrowseResultMask::ISFORWARD);
        const RHS: ua::BrowseResultMask = ua::BrowseResultMask::REFERENCETYPEINFO;
        assert_eq!(LHS, RHS);

        // We support mask combinators with `|` shorthand notation.
        let lhs = ua::BrowseResultMask::REFERENCETYPEID | ua::BrowseResultMask::ISFORWARD;
        let rhs = ua::BrowseResultMask::REFERENCETYPEINFO;
        assert_eq!(lhs, rhs);
    }
}