Struct ScalarUdfSeries 

pub struct ScalarUdfSeries { /* private fields */ }

Executes user-provided scalar UDF code over aligned inputs. The function must return one output for each aligned input row, with the return type matching the series type that contains this node.

Implementations

impl ScalarUdfSeries

pub fn builder() -> Builder<SourceStage>

Returns a new builder.

impl ScalarUdfSeries

pub fn new(source: UdfSource) -> ScalarUdfSeries

Constructs a new instance of the type.

pub fn inputs(&self) -> &[Series]

Input series passed to the UDF in argument order.

pub fn source(&self) -> &UdfSource

Language-specific source definition for the UDF.

Trait Implementations

impl Clone for ScalarUdfSeries

fn clone(&self) -> ScalarUdfSeries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScalarUdfSeries

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScalarUdfSeries

fn deserialize<__D>( __deserializer: __D, ) -> Result<ScalarUdfSeries, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ScalarUdfSeries

impl From<ScalarUdfSeries> for Builder<Complete>

fn from(v: ScalarUdfSeries) -> Builder<Complete>

Converts to this type from the input type.

impl Hash for ScalarUdfSeries

fn hash<H>(&self, hasher: &mut H)

where H: Hasher,

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 ScalarUdfSeries

fn cmp(&self, other: &ScalarUdfSeries) -> 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 ScalarUdfSeries

fn eq(&self, other: &ScalarUdfSeries) -> 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 ScalarUdfSeries

fn partial_cmp(&self, other: &ScalarUdfSeries) -> 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 ScalarUdfSeries

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

where __S: Serializer,

Serialize this value into the given Serde serializer.