nominal-api 0.1239.0

API bindings for the Nominal platform
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

/// A channel (by name) found in one or more locators of the frame. `locatorMetadata` has one
/// entry per locator the channel exists in; locators not represented here are ones where the
/// channel does not exist.
#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash
)]
#[serde(crate = "conjure_object::serde")]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct ChannelEntry {
    #[serde(rename = "name")]
    name: super::super::super::super::api::Channel,
    #[builder(default, set(item(type = super::LocatorChannelMetadata)))]
    #[serde(
        rename = "locatorMetadata",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    locator_metadata: std::collections::BTreeSet<super::LocatorChannelMetadata>,
}
impl ChannelEntry {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(name: super::super::super::super::api::Channel) -> Self {
        Self::builder().name(name).build()
    }
    #[inline]
    pub fn name(&self) -> &super::super::super::super::api::Channel {
        &self.name
    }
    #[inline]
    pub fn locator_metadata(
        &self,
    ) -> &std::collections::BTreeSet<super::LocatorChannelMetadata> {
        &self.locator_metadata
    }
}