Skip to main content

nominal_api/conjure/objects/scout/compute/api/
combine_struct_series.rs

1/// Combines multiple typed input series into one struct-valued series. Inputs are ordered: downstream UDFs map
2/// these inputs positionally to Rust vector parameters. Alignment uses the interpolation configuration before
3/// producing row-aligned values.
4#[derive(
5    Debug,
6    Clone,
7    conjure_object::serde::Serialize,
8    conjure_object::serde::Deserialize,
9    conjure_object::private::DeriveWith
10)]
11#[serde(crate = "conjure_object::serde")]
12#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
13#[conjure_object::private::staged_builder::staged_builder]
14#[builder(crate = conjure_object::private::staged_builder, update, inline)]
15pub struct CombineStructSeries {
16    #[builder(default, list(item(type = super::Series)))]
17    #[serde(rename = "inputs", skip_serializing_if = "Vec::is_empty", default)]
18    inputs: Vec<super::Series>,
19    #[builder(
20        default,
21        custom(
22            type = impl
23            Into<Option<super::InterpolationConfiguration>>,
24            convert = |v|v.into().map(Box::new)
25        )
26    )]
27    #[serde(
28        rename = "interpolationConfiguration",
29        skip_serializing_if = "Option::is_none",
30        default
31    )]
32    interpolation_configuration: Option<Box<super::InterpolationConfiguration>>,
33}
34impl CombineStructSeries {
35    /// Constructs a new instance of the type.
36    #[inline]
37    pub fn new() -> Self {
38        Self::builder().build()
39    }
40    /// Input series in argument order.
41    #[inline]
42    pub fn inputs(&self) -> &[super::Series] {
43        &*self.inputs
44    }
45    /// Optional interpolation rules used when aligning input series before combining them.
46    #[inline]
47    pub fn interpolation_configuration(
48        &self,
49    ) -> Option<&super::InterpolationConfiguration> {
50        self.interpolation_configuration.as_ref().map(|o| &**o)
51    }
52}