Re-exportsยง
use crate::decoder::OffsetSizeBytes;๐use crate::decoder::VariantBasicType;๐use crate::decoder::VariantPrimitiveType;๐use crate::ShortString;๐use crate::Variant;๐use crate::VariantDecimal4;๐use crate::VariantDecimal8;๐use crate::VariantDecimal16;๐use crate::VariantList;๐use crate::VariantMetadata;๐use crate::VariantObject;๐use arrow_schema::ArrowError;๐use chrono::Timelike;๐use uuid::Uuid;๐
Modulesยง
Macrosยง
- variant_
append_ ๐value - Macro to generate the match statement for each append_variant, try_append_variant, and append_variant_bytes โ they each have slightly different handling for object and list handling.
Structsยง
- List
Builder - A builder for creating
Variant::Listvalues. - List
State - Internal state for list building
- Object
Builder - A builder for creating
Variant::Objectvalues. - Object
Field Builder - A
VariantBuilderExtthat inserts a new field into a variant object. - Object
Header Writer - Object
State - Internal state for object building
- Parent
State - Tracks information needed to correctly finalize a nested builder.
- Read
Only Metadata Builder - A metadata builder that cannot register new field names, and merely returns the field id associated with a known field name. This is useful for variant unshredding operations, where the metadata column is fixed and โ per variant shredding spec โ already contains all field names from the typed_value column. It is also useful when projecting a subset of fields from a variant object value, since the bytes can be copied across directly without re-encoding their field ids.
- Value
Builder - Wrapper around a
Vec<u8>that provides methods for appending primitive values, variant types, and metadata. - Variant
Builder - Top level builder for
Variantvalues - Writable
Metadata Builder - Builder for constructing metadata for
Variantvalues.
Constantsยง
- BASIC_
TYPE_ ๐BITS - EMPTY_
BUILDER_ ๐MSG - ONE_
TOP_ ๐LEVEL_ VALUE_ MSG - UNIX_
EPOCH_ ๐DATE
Traitsยง
- Builder
Specific State - A trait for managing state specific to different builder types.
- Metadata
Builder - A trait for building variant metadata dictionaries, to be used in conjunction with a
ValueBuilder. The trait provides methods for managing field names and their IDs, as well as rolling back a failed builder operation that might have created new field ids. - Variant
Builder Ext - Extends
VariantBuilderto help building nestedVariants
Functionsยง
- append_
packed_ u32 - Append
value_sizebytes of givenvalueintodest. - append_
packed_ u32 - array_
header - empty_
builder_ ๐error - int_
size ๐ - object_
header - primitive_
header ๐ - short_
string_ ๐header - top_
level_ ๐value_ error - top_
level_ ๐value_ panic - write_
offset - Write little-endian integer to buffer