Struct StructLayout 

pub struct StructLayout { /* private fields */ }

Implementations

impl StructLayout

pub fn new(row_count: u64, dtype: DType, children: Vec<LayoutRef>) -> Self

pub fn struct_fields(&self) -> &StructFields

pub fn row_count(&self) -> u64

pub fn children(&self) -> &Arc<dyn LayoutChildren>

pub fn matching_fields<F>( &self, field_mask: &[FieldMask], per_child: F, ) -> VortexResult<()>

where F: FnMut(FieldMask, usize) -> VortexResult<()>,

Methods from Deref<Target = 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.

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 StructLayout

fn as_ref(&self) -> &dyn Layout

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

impl Clone for StructLayout

fn clone(&self) -> StructLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructLayout

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

Formats the value using the given formatter.

impl Deref for StructLayout

type Target = dyn Layout

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<StructLayout> for LayoutRef

fn from(value: StructLayout) -> LayoutRef

Converts to this type from the input type.

impl IntoLayout for StructLayout

fn into_layout(self) -> LayoutRef

Converts this type into a LayoutRef.