Struct DictLayout 

pub struct DictLayout { /* private fields */ }

Implementations

impl DictLayout

pub unsafe fn set_all_values_referenced( self, all_values_referenced: bool, ) -> Self

Set whether all dictionary values are definitely referenced.

Safety

The caller must ensure that when setting all_values_referenced = true, ALL dictionary values are actually referenced by at least one valid code. Setting this incorrectly can lead to incorrect query results in operations like min/max.

This is typically only set to true during dictionary encoding when we know for certain that all values are referenced. See DictArray::set_all_values_referenced.

pub fn has_all_values_referenced(&self) -> bool

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.

Trait Implementations

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 Clone for DictLayout

fn clone(&self) -> DictLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DictLayout

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

Formats the value using the given formatter.

impl Deref for DictLayout

type Target = dyn Layout

The resulting type after dereferencing.

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

Dereferences the value.

impl From<DictLayout> for LayoutRef

fn from(value: DictLayout) -> LayoutRef

Converts to this type from the input type.

impl IntoLayout for DictLayout

fn into_layout(self) -> LayoutRef

Converts this type into a LayoutRef.