Struct SparseLayout 

pub struct SparseLayout {
    pub value_compression: Option<CompressiveEncoding>,
    pub num_buffers: u64,
    pub num_items: u64,
    pub num_visible_items: u64,
    pub has_large_chunk: bool,
    pub structural_layers: Vec<SparseStructuralLayer>,
}

A layout used for sparse flat or nested pages where Arrow structure is represented directly in layer-local slot domains instead of as dense repetition / definition events.

Structural layers are ordered from outer-most to inner-most. Values remain mini-block compressed and are split into independently readable chunks.

Fields

value_compression: Option<CompressiveEncoding>

Description of the compression of values.

num_buffers: u64

Number of value buffers in each mini-block chunk. This does not include structural buffers.

num_items: u64

Number of entries in the equivalent dense repetition / definition stream. This equals num_visible_items plus one structural placeholder for every list slot without children. Null leaf slots count as visible items because they still occupy positions in Arrow’s leaf value buffer. For example, a nullable primitive with 100 slots, 30 of them null, has num_items = num_visible_items = 100.

num_visible_items: u64

Number of leaf value slots encoded in the value chunks, including null leaf slots.

has_large_chunk: bool

If true, chunk-local value buffer sizes use u32. Otherwise they use u16.

structural_layers: Vec<SparseStructuralLayer>

Structural layers ordered from outer-most to inner-most. This may be empty for a flat, non-nullable leaf page whose scheduling domain equals num_visible_items.

Trait Implementations

impl Clone for SparseLayout

fn clone(&self) -> SparseLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SparseLayout

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

Formats the value using the given formatter.

impl Default for SparseLayout

fn default() -> Self

Returns the “default value” for a type.

impl Message for SparseLayout

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for SparseLayout

const NAME: &'static str = "SparseLayout"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "lance.encodings21"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for SparseLayout

fn eq(&self, other: &SparseLayout) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SparseLayout