Struct ShreddingSpec 

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

A list of (path, dtype) directives describing which Variant paths to shred and as what type.

Paths must contain only object-field elements; list index elements are rejected because Parquet Variant shredding schemas cannot express list element shredding yet. The root path ($) shreds the top-level value itself. When entries overlap (e.g. $.a and $.a.b), later entries overwrite earlier ones.

Implementations

impl ShreddingSpec

pub fn empty() -> Self

Creates an empty spec, meaning no shredding is performed.

pub fn try_new( fields: impl IntoIterator<Item = (VariantPath, DType)>, ) -> VortexResult<Self>

Creates a spec from (path, dtype) directives.

Errors

Returns an error if any path contains a list index element.

pub fn fields(&self) -> &[(VariantPath, DType)]

Returns the (path, dtype) directives.

pub fn is_empty(&self) -> bool

Returns whether this spec contains no directives.

Trait Implementations

impl Clone for ShreddingSpec

fn clone(&self) -> ShreddingSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShreddingSpec

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

Formats the value using the given formatter.

impl Default for ShreddingSpec

fn default() -> ShreddingSpec

Returns the “default value” for a type.

impl Display for ShreddingSpec

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

Formats the value using the given formatter.

impl Eq for ShreddingSpec

impl Hash for ShreddingSpec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ShreddingSpec

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ShreddingSpec