Struct LayoutData

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

LayoutData is the lazy equivalent to vortex_array::ArrayData, providing a hierarchical structure.

Implementations

impl LayoutData

pub fn new_owned( encoding: LayoutEncodingRef, dtype: DType, row_count: u64, segments: Option<Vec<SegmentId>>, children: Option<Vec<LayoutData>>, metadata: Option<Bytes>, ) -> Self

Create a new owned layout.

pub fn try_new_viewed( encoding: LayoutEncodingRef, dtype: DType, flatbuffer: ByteBuffer, flatbuffer_loc: usize, ctx: LayoutContextRef, ) -> VortexResult<Self>

Create a new viewed layout from a flatbuffer root message.

pub unsafe fn new_viewed_unchecked( encoding: LayoutEncodingRef, dtype: DType, flatbuffer: ByteBuffer, flatbuffer_loc: usize, ctx: LayoutContextRef, ) -> 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 encoding(&self) -> LayoutEncodingRef

Returns the crate::LayoutEncoding 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) -> VortexResult<LayoutData>

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 layout metadata

pub fn reader( &self, segments: Arc<dyn AsyncSegmentReader>, ctx: ContextRef, ) -> VortexResult<Arc<dyn LayoutReader + 'static>>

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.

Trait Implementations

impl Clone for LayoutData

fn clone(&self) -> LayoutData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutData

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

Formats the value using the given formatter.

impl WriteFlatBuffer for LayoutData

type Target<'a> = Layout<'a>

fn write_flatbuffer<'fb>( &self, fbb: &mut FlatBufferBuilder<'fb>, ) -> WIPOffset<Self::Target<'fb>>

impl FlatBufferRoot for LayoutData