Trait Layout 

pub trait Layout:
    'static
    + Send
    + Sync
    + Debug
    + Sealed {
    // Required methods
    fn as_any(&self) -> &dyn Any;
    fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any + Send + Sync>;
    fn to_layout(&self) -> LayoutRef;
    fn encoding(&self) -> LayoutEncodingRef;
    fn row_count(&self) -> u64;
    fn dtype(&self) -> &DType;
    fn nchildren(&self) -> usize;
    fn child(&self, idx: usize) -> VortexResult<LayoutRef>;
    fn child_type(&self, idx: usize) -> LayoutChildType;
    fn metadata(&self) -> Vec<u8> ;
    fn segment_ids(&self) -> Vec<SegmentId>;
    fn new_reader(
        &self,
        name: Arc<str>,
        segment_source: Arc<dyn SegmentSource>,
        session: &VortexSession,
    ) -> VortexResult<LayoutReaderRef>;
}

Required Methods

fn as_any(&self) -> &dyn Any

fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any + Send + Sync>

fn to_layout(&self) -> LayoutRef

fn encoding(&self) -> LayoutEncodingRef

Returns the crate::LayoutEncoding for this layout.

fn row_count(&self) -> u64

The number of rows in this layout.

fn dtype(&self) -> &DType

The dtype of this layout when projected with the root scope.

fn nchildren(&self) -> usize

The number of children in this layout.

fn child(&self, idx: usize) -> VortexResult<LayoutRef>

Get the child at the given index.

fn child_type(&self, idx: usize) -> LayoutChildType

Get the relative row offset of the child at the given index, returning None for any auxiliary children, e.g. dictionary values, zone maps, etc.

fn metadata(&self) -> Vec<u8>

Get the metadata for this layout.

fn segment_ids(&self) -> Vec<SegmentId>

Get the segment IDs for this layout.

fn new_reader( &self, name: Arc<str>, segment_source: Arc<dyn SegmentSource>, session: &VortexSession, ) -> VortexResult<LayoutReaderRef>

Implementations

impl dyn Layout + '_

pub fn flatbuffer_writer<'a>( &'a self, ctx: &'a LayoutContext, ) -> impl WriteFlatBuffer<Target<'a> = Layout<'a>> + FlatBufferRoot + 'a

Serialize the layout into a FlatBufferBuilder.

impl dyn Layout + '_

pub fn encoding_id(&self) -> LayoutEncodingId

The ID of the encoding for this layout.

pub fn children(&self) -> VortexResult<Vec<LayoutRef>>

The children of this layout.

pub fn child_types(&self) -> impl Iterator<Item = LayoutChildType>

The child types of this layout.

pub fn child_names(&self) -> impl Iterator<Item = Arc<str>>

The names of the children of this layout.

pub fn child_row_offsets(&self) -> impl Iterator<Item = Option<u64>>

The row offsets of the children of this layout, where None indicates an auxiliary child.

pub fn is<V: VTable>(&self) -> bool

pub fn as_<V: VTable>(&self) -> &V::Layout

Downcast a layout to a specific type.

pub fn as_opt<V: VTable>(&self) -> Option<&V::Layout>

Downcast a layout to a specific type.

pub fn into<V: VTable>(self: Arc<Self>) -> Arc<V::Layout>

Downcast a layout to a specific type.

pub fn depth_first_traversal( &self, ) -> impl Iterator<Item = VortexResult<LayoutRef>>

Depth-first traversal of the layout and its children.

pub fn display_tree(&self) -> DisplayLayoutTree

Display the layout as a tree structure.

pub fn display_tree_verbose(&self, verbose: bool) -> DisplayLayoutTree

Display the layout as a tree structure with optional verbose metadata.

pub async fn display_tree_with_segments( &self, segment_source: Arc<dyn SegmentSource>, ) -> VortexResult<DisplayLayoutTree>

Display the layout as a tree structure, fetching segment buffer sizes from the segment source.

Warning

This function performs IO to fetch each segment’s buffer. For layouts with many segments, this may result in significant IO overhead.

Trait Implementations

impl AsRef<dyn Layout> for ChunkedLayout

fn as_ref(&self) -> &dyn Layout

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<dyn Layout> for DictLayout

fn as_ref(&self) -> &dyn Layout

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<dyn Layout> for FlatLayout

fn as_ref(&self) -> &dyn Layout

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<dyn Layout> for StructLayout

fn as_ref(&self) -> &dyn Layout

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<dyn Layout> for ZonedLayout

fn as_ref(&self) -> &dyn Layout

Converts this type into a shared reference of the (usually inferred) input type.

impl Display for dyn Layout + '_

Display the encoding, dtype, row count, and segment IDs of this layout.

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

Formats the value using the given formatter.

Implementors

impl<V: VTable> Layout for LayoutAdapter<V>