pub struct FunctionFlags(/* private fields */);
Implementations§
Source§impl FunctionFlags
impl FunctionFlags
pub const ALLOW_GROUP_AWARE: Self = _
pub const CHANGES_LENGTH: Self = _
pub const ALLOW_RENAME: Self = _
pub const PASS_NAME_TO_APPLY: Self = _
Sourcepub const INPUT_WILDCARD_EXPANSION: Self = _
pub const INPUT_WILDCARD_EXPANSION: Self = _
There can be two ways of expanding wildcards:
Say the schema is ‘a’, ‘b’ and there is a function f
. In this case, f('*')
can expand
to:
f('a', 'b')
f('a'), f('b')
Setting this to true, will lead to behavior 1.
This also accounts for regex expansion.
Sourcepub const RETURNS_SCALAR: Self = _
pub const RETURNS_SCALAR: Self = _
Automatically explode on unit length if it ran as final aggregation.
this is the case for aggregations like sum, min, covariance etc. We need to know this because we cannot see the difference between the following functions based on the output type and number of elements:
x: {1, 2, 3}
head_1(x) -> {1} sum(x) -> {4}
Sourcepub const OPTIONAL_RE_ENTRANT: Self = _
pub const OPTIONAL_RE_ENTRANT: Self = _
This can happen with UDF’s that use Polars within the UDF. This can lead to recursively entering the engine and sometimes deadlocks. This flag must be set to handle that.
Sourcepub const ALLOW_EMPTY_INPUTS: Self = _
pub const ALLOW_EMPTY_INPUTS: Self = _
Whether this function allows no inputs.
Source§impl FunctionFlags
impl FunctionFlags
Sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
Sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> Self
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
Sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
Sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
Sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
Sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
Sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
Sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
Sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§impl FunctionFlags
impl FunctionFlags
Sourcepub const fn iter(&self) -> Iter<FunctionFlags>
pub const fn iter(&self) -> Iter<FunctionFlags>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
Sourcepub const fn iter_names(&self) -> IterNames<FunctionFlags>
pub const fn iter_names(&self) -> IterNames<FunctionFlags>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
Source§impl Binary for FunctionFlags
impl Binary for FunctionFlags
Source§impl BitAnd for FunctionFlags
impl BitAnd for FunctionFlags
Source§impl BitAndAssign for FunctionFlags
impl BitAndAssign for FunctionFlags
Source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
Source§impl BitOr for FunctionFlags
impl BitOr for FunctionFlags
Source§fn bitor(self, other: FunctionFlags) -> Self
fn bitor(self, other: FunctionFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
Source§type Output = FunctionFlags
type Output = FunctionFlags
|
operator.Source§impl BitOrAssign for FunctionFlags
impl BitOrAssign for FunctionFlags
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
Source§impl BitXor for FunctionFlags
impl BitXor for FunctionFlags
Source§impl BitXorAssign for FunctionFlags
impl BitXorAssign for FunctionFlags
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§impl Clone for FunctionFlags
impl Clone for FunctionFlags
Source§fn clone(&self) -> FunctionFlags
fn clone(&self) -> FunctionFlags
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FunctionFlags
impl Debug for FunctionFlags
Source§impl Default for FunctionFlags
impl Default for FunctionFlags
Source§impl<'de> Deserialize<'de> for FunctionFlags
impl<'de> Deserialize<'de> for FunctionFlags
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl Extend<FunctionFlags> for FunctionFlags
impl Extend<FunctionFlags> for FunctionFlags
Source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
Source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Source§impl Flags for FunctionFlags
impl Flags for FunctionFlags
Source§const FLAGS: &'static [Flag<FunctionFlags>] = _
const FLAGS: &'static [Flag<FunctionFlags>] = _
Source§fn from_bits_retain(bits: u8) -> FunctionFlags
fn from_bits_retain(bits: u8) -> FunctionFlags
Source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
Source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
Source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
Source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.Source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moreSource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.Source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.Source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moreSource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.Source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.Source§impl FromIterator<FunctionFlags> for FunctionFlags
impl FromIterator<FunctionFlags> for FunctionFlags
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
Source§impl Hash for FunctionFlags
impl Hash for FunctionFlags
Source§impl IntoIterator for FunctionFlags
impl IntoIterator for FunctionFlags
Source§impl LowerHex for FunctionFlags
impl LowerHex for FunctionFlags
Source§impl Not for FunctionFlags
impl Not for FunctionFlags
Source§impl Octal for FunctionFlags
impl Octal for FunctionFlags
Source§impl PartialEq for FunctionFlags
impl PartialEq for FunctionFlags
Source§impl PublicFlags for FunctionFlags
impl PublicFlags for FunctionFlags
Source§impl Serialize for FunctionFlags
impl Serialize for FunctionFlags
Source§impl Sub for FunctionFlags
impl Sub for FunctionFlags
Source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Source§type Output = FunctionFlags
type Output = FunctionFlags
-
operator.Source§impl SubAssign for FunctionFlags
impl SubAssign for FunctionFlags
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Source§impl UpperHex for FunctionFlags
impl UpperHex for FunctionFlags
impl Copy for FunctionFlags
impl Eq for FunctionFlags
impl StructuralPartialEq for FunctionFlags
Auto Trait Implementations§
impl Freeze for FunctionFlags
impl RefUnwindSafe for FunctionFlags
impl Send for FunctionFlags
impl Sync for FunctionFlags
impl Unpin for FunctionFlags
impl UnwindSafe for FunctionFlags
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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