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
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

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    conjure_object::private::DeriveWith
)]
#[serde(crate = "conjure_object::serde")]
#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct Context {
    #[builder(
        default,
        map(key(type = super::VariableName), value(type = super::VariableValue))
    )]
    #[serde(
        rename = "variables",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    variables: std::collections::BTreeMap<super::VariableName, super::VariableValue>,
    #[builder(default, into)]
    #[serde(
        rename = "functionVariables",
        skip_serializing_if = "Option::is_none",
        default
    )]
    function_variables: Option<
        std::collections::BTreeMap<super::FunctionReference, super::FunctionVariables>,
    >,
    #[builder(
        default,
        map(key(type = super::FrameReferenceName), value(type = super::DataFrame))
    )]
    #[serde(
        rename = "frameReferences",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    frame_references: std::collections::BTreeMap<
        super::FrameReferenceName,
        super::DataFrame,
    >,
}
impl Context {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new() -> Self {
        Self::builder().build()
    }
    #[inline]
    pub fn variables(
        &self,
    ) -> &std::collections::BTreeMap<super::VariableName, super::VariableValue> {
        &self.variables
    }
    #[deprecated(
        note = "This field is deprecated and will be removed in a future version.\n"
    )]
    #[inline]
    pub fn function_variables(
        &self,
    ) -> Option<
        &std::collections::BTreeMap<super::FunctionReference, super::FunctionVariables>,
    > {
        self.function_variables.as_ref().map(|o| &*o)
    }
    /// Named frames looked up by `FrameReference` nodes in the compute tree.
    #[inline]
    pub fn frame_references(
        &self,
    ) -> &std::collections::BTreeMap<super::FrameReferenceName, super::DataFrame> {
        &self.frame_references
    }
}