Struct RustUdfSource 

pub struct RustUdfSource { /* private fields */ }

Rust source code defining the UDF entrypoint and any helper functions.

Implementations

impl RustUdfSource

pub fn builder() -> Builder<SourceCodeStage>

Returns a new builder.

impl RustUdfSource

pub fn new(source_code: impl Into<String>) -> Self

Constructs a new instance of the type.

pub fn source_code(&self) -> &str

Rust source code to transpiled into WASM. The source may contain a single function as the entrypoint, or if several functions appear at the top level, annotate the entrypoint with #[main]. Entrypoint must return a single f64 value. Parameters must be typed as f64 for numeric inputes or String for categorical inputs.

Single function example:

fn run(a: f64, b: f64) -> f64 {
  a + b
}

Main with helper function:

#[main]
fn run(sample: f64, band_size: f64) -> f64 {
  excedance_count(sample, band_size)
}

fn excedance_count(value: f64, band_size: f64) -> f64 {
  let mut excedances = 0.0;
  for i in 1..=5 {
    if value > band_size * i as f64 {
      excedances += 1.0;
    }
  }
  excedances
}

Trait Implementations

impl Clone for RustUdfSource

fn clone(&self) -> RustUdfSource

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RustUdfSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RustUdfSource

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RustUdfSource> for Builder<Complete>

fn from(v: RustUdfSource) -> Self

Converts to this type from the input type.

impl Hash for RustUdfSource

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RustUdfSource

fn cmp(&self, other: &RustUdfSource) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RustUdfSource

fn eq(&self, other: &RustUdfSource) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RustUdfSource

fn partial_cmp(&self, other: &RustUdfSource) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RustUdfSource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RustUdfSource

impl StructuralPartialEq for RustUdfSource