Struct ReturnFieldArgs

Source
pub struct ReturnFieldArgs<'a> {
    pub arg_fields: &'a [FieldRef],
    pub scalar_arguments: &'a [Option<&'a ScalarValue>],
}
Expand description

Information about arguments passed to the function

This structure contains metadata about how the function was called such as the type of the arguments, any scalar arguments and if the arguments can (ever) be null

See ScalarUDFImpl::return_field_from_args for more information

Fields§

§arg_fields: &'a [FieldRef]

The data types of the arguments to the function

§scalar_arguments: &'a [Option<&'a ScalarValue>]

Is argument i to the function a scalar (constant)?

If the argument i is not a scalar, it will be None

For example, if a function is called like my_function(column_a, 5) this field will be [None, Some(ScalarValue::Int32(Some(5)))]

Trait Implementations§

Source§

impl<'a> Debug for ReturnFieldArgs<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for ReturnFieldArgs<'a>

§

impl<'a> !RefUnwindSafe for ReturnFieldArgs<'a>

§

impl<'a> Send for ReturnFieldArgs<'a>

§

impl<'a> Sync for ReturnFieldArgs<'a>

§

impl<'a> Unpin for ReturnFieldArgs<'a>

§

impl<'a> !UnwindSafe for ReturnFieldArgs<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.