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

/// Adds a derived numeric series to the base frame. If a series with the same name already exists,
/// then it will be replaced.
#[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 WithNumericSeriesFrame {
    #[builder(custom(type = super::DataFrame, convert = Box::new))]
    #[serde(rename = "input")]
    input: Box<super::DataFrame>,
    #[builder(custom(type = super::StringConstant, convert = Box::new))]
    #[serde(rename = "name")]
    name: Box<super::StringConstant>,
    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
    #[serde(rename = "definition")]
    definition: Box<super::NumericSeries>,
}
impl WithNumericSeriesFrame {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        input: super::DataFrame,
        name: super::StringConstant,
        definition: super::NumericSeries,
    ) -> Self {
        Self::builder().input(input).name(name).definition(definition).build()
    }
    /// The base frame to which the new series will be added.
    #[inline]
    pub fn input(&self) -> &super::DataFrame {
        &*self.input
    }
    /// Name of the new derived series.
    #[inline]
    pub fn name(&self) -> &super::StringConstant {
        &*self.name
    }
    /// Compute expression defining the series values.
    #[inline]
    pub fn definition(&self) -> &super::NumericSeries {
        &*self.definition
    }
}