nominal-api 0.1240.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

#[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 Function {
    #[builder(into)]
    #[serde(rename = "name")]
    name: String,
    #[builder(into)]
    #[serde(rename = "description")]
    description: String,
    #[builder(default, list(item(type = super::FunctionParameter)))]
    #[serde(rename = "parameters", skip_serializing_if = "Vec::is_empty", default)]
    parameters: Vec<super::FunctionParameter>,
    #[builder(custom(type = super::FunctionNode, convert = Box::new))]
    #[serde(rename = "functionNode")]
    function_node: Box<super::FunctionNode>,
    #[serde(rename = "isExported")]
    is_exported: bool,
}
impl Function {
    /// The name of the function. This should be unique to the function in the current module.
    #[inline]
    pub fn name(&self) -> &str {
        &*self.name
    }
    #[inline]
    pub fn description(&self) -> &str {
        &*self.description
    }
    #[inline]
    pub fn parameters(&self) -> &[super::FunctionParameter] {
        &*self.parameters
    }
    #[inline]
    pub fn function_node(&self) -> &super::FunctionNode {
        &*self.function_node
    }
    #[inline]
    pub fn is_exported(&self) -> bool {
        self.is_exported
    }
}