Struct Layout

pub struct Layout(/* private fields */);

Layout is the lazy equivalent to vortex_array::ArrayRef, providing a hierarchical structure.

Implementations

impl Layout

pub fn new_owned( name: Arc<str>, vtable: LayoutVTableRef, dtype: DType, row_count: u64, segments: Vec<SegmentId>, children: Vec<Layout>, metadata: Option<Bytes>, ) -> Self

Create a new owned layout.

pub unsafe fn new_viewed_unchecked( name: Arc<str>, encoding: LayoutVTableRef, dtype: DType, flatbuffer: FlatBuffer, flatbuffer_loc: usize, ctx: LayoutContext, ) -> Self

Create a new viewed layout from a flatbuffer root message.

SAFETY

Assumes that flatbuffer has been previously validated and has same encoding id as the passed encoding

pub fn name(&self) -> &str

Returns the human-readable name of the layout.

pub fn vtable(&self) -> &LayoutVTableRef

Returns the crate::LayoutVTable for this layout.

pub fn id(&self) -> LayoutId

Returns the ID of the layout.

pub fn row_count(&self) -> u64

Return the row-count of the layout.

pub fn dtype(&self) -> &DType

Return the data type of the layout.

pub fn nchildren(&self) -> usize

Returns the number of children of the layout.

pub fn child( &self, i: usize, dtype: DType, name: impl AsRef<str>, ) -> VortexResult<Layout>

Fetch the i’th child layout.

Panics

Panics if the child index is out of bounds.

pub fn child_row_count(&self, i: usize) -> u64

Fetch the row count of the i’th child layout.

Panics

Panics if the child index is out of bounds.

pub fn nsegments(&self) -> usize

Returns the number of segments in the layout.

pub fn segment_id(&self, i: usize) -> Option<SegmentId>

Fetch the i’th segment id of the layout.

pub fn segments(&self) -> impl Iterator<Item = SegmentId> + '_

Iterate the segment IDs of the layout.

pub fn metadata(&self) -> Option<Bytes>

Returns the bytes of the metadata stored in the layout’s flatbuffer.

pub fn reader( &self, segment_reader: Arc<dyn AsyncSegmentReader>, ctx: ArrayContext, ) -> VortexResult<Arc<dyn LayoutReader>>

Create a reader for this layout.

pub fn register_splits( &self, field_mask: &[FieldMask], row_offset: u64, splits: &mut BTreeSet<u64>, ) -> VortexResult<()>

Register splits for this layout.

pub fn required_segments( &self, row_offset: u64, filter_field_mask: &[FieldMask], projection_field_mask: &[FieldMask], segments: &mut SegmentCollector, ) -> VortexResult<()>

Registers matching segments to the given filter and projection field mask.

pub fn write_flatbuffer<'fbb>( &self, fbb: &mut FlatBufferBuilder<'fbb>, ctx: &LayoutContext, ) -> WIPOffset<Layout<'fbb>>

Serialize the layout into a FlatBufferBuilder.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.