Skip to main content

FieldSelection

Enum FieldSelection 

pub enum FieldSelection {
    All,
    Fields(Box<IndexMap<PlSmallStr, FieldSelection, RandomState>>),
    Element(Box<FieldSelection>),
}
Available on crate feature lazy only.
Expand description

Which parts of one column’s value are needed.

Built by projection pushdown, which reads struct fields by name; non-struct values are always All. See agent-docs/nested-projection-pushdown/01-field-pruning.md.

Variants§

§

All

The whole value (every field, recursively). The default; all non-nested columns.

§

Fields(Box<IndexMap<PlSmallStr, FieldSelection, RandomState>>)

Only these struct fields, each with its own selection. Empty: only the row count and the outer validity are needed (s.is_null(), len).

§

Element(Box<FieldSelection>)

The element of a List or Array, with its own selection, plus the offsets and validity of the list. Never Element(All), which is All.

Implementations§

§

impl FieldSelection

pub fn validity_only() -> FieldSelection

Only the row count and the outer validity.

pub fn field(name: PlSmallStr, selection: FieldSelection) -> FieldSelection

Only the field name, with selection.

pub fn element(selection: FieldSelection) -> FieldSelection

The element of a list or array with selection; All if selection is.

pub fn is_all(&self) -> bool

pub fn fields( &self, ) -> Option<&IndexMap<PlSmallStr, FieldSelection, RandomState>>

pub fn child(&self, name: &str) -> Option<&FieldSelection>

The selection of field name: All under All, None if the field is not needed. All for an element selection, which has no fields.

pub fn element_selection(&self) -> &FieldSelection

The selection of the element of a list: All unless an element selection.

pub fn union(&mut self, other: FieldSelection)

Merges the needs of another consumer of the same value into self. All absorbs everything, field maps merge key by key and validity-only is absorbed by any selection.

pub fn insert_child(&mut self, name: PlSmallStr, selection: FieldSelection)

Unions field name with selection into self. Does nothing under All; makes an element selection All, as it has no fields.

pub fn normalize(self, dtype: &DataType) -> FieldSelection

Makes the selection canonical for dtype: non-struct values and structs with every field selected whole become All, and fields that dtype does not have are dropped.

pub fn prune_dtype(&self, dtype: &DataType) -> DataType

The dtype with only the selected fields, in the order of dtype.

pub fn prune_arrow_field(&self, field: &Field) -> Field

Self::prune_dtype for an arrow field: field with only the selected struct fields.

pub fn prune_arrow_dtype(&self, dtype: &ArrowDataType) -> ArrowDataType

Self::prune_dtype for an arrow dtype. Only plain structs and lists are pruned: anything else is kept whole.

pub fn intersect(&self, other: &FieldSelection) -> FieldSelection

What both self and other, two selections of one value, select. self if they are not from one dtype.

pub fn of_target_dtype(dtype: &DataType, target: &DataType) -> FieldSelection

The fields of dtype that target has, matched by name, recursively: what a cast of dtype to target that ignores extra struct fields keeps. A field target has and dtype lacks is left out; a struct none of whose fields target has is needed for its validity only.

pub fn of_narrowed_dtype( dtype: &DataType, narrowed: &DataType, ) -> FieldSelection

The fields of dtype that narrowed, dtype with some struct fields left out, has. Like Self::of_target_dtype, but a struct narrowed has a field of that dtype lacks is not a narrowing of it, and is read whole.

Trait Implementations§

§

impl Clone for FieldSelection

§

fn clone(&self) -> FieldSelection

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for FieldSelection

§

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

Formats the value using the given formatter. Read more
§

impl Default for FieldSelection

§

fn default() -> FieldSelection

Returns the “default value” for a type. Read more
§

impl<'de> Deserialize<'de> for FieldSelection

§

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

Deserialize this value from the given Serde deserializer. Read more
§

impl Display for FieldSelection

§

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

Formats the value using the given formatter. Read more
§

impl Eq for FieldSelection

§

impl Hash for FieldSelection

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl PartialEq for FieldSelection

§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
§

impl Serialize for FieldSelection

§

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. Read more
§

impl StructuralPartialEq for FieldSelection

Auto Trait Implementations§

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Key for T
where T: Clone,

Source§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
Source§

fn size(&self) -> usize

The size of the key in bytes.
Source§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
Source§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
Source§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more
§

impl<T> PlanCallbackArgs for T

§

impl<T> PlanCallbackOut for T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> ToCompactString for T
where T: Display,

§

fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>

Fallible version of [ToCompactString::to_compact_string()] Read more
§

fn to_compact_string(&self) -> CompactString

Converts the given value to a [CompactString]. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more