Enum mz_avro::schema::SchemaPiece

pub enum SchemaPiece {
    Null,
    Boolean,
    Int,
    Long,
    Float,
    Double,
    Date,
    TimestampMilli,
    TimestampMicro,
    Decimal {
        precision: usize,
        scale: usize,
        fixed_size: Option<usize>,
    },
    Bytes,
    String,
    Json,
    Uuid,
    Array(Box<SchemaPieceOrNamed>),
    Map(Box<SchemaPieceOrNamed>),
    Union(UnionSchema),
    ResolveIntTsMilli,
    ResolveIntTsMicro,
    ResolveDateTimestamp,
    ResolveIntLong,
    ResolveIntFloat,
    ResolveIntDouble,
    ResolveLongFloat,
    ResolveLongDouble,
    ResolveFloatDouble,
    ResolveConcreteUnion {
        index: usize,
        inner: Box<SchemaPieceOrNamed>,
        n_reader_variants: usize,
        reader_null_variant: Option<usize>,
    },
    ResolveUnionUnion {
        permutation: Vec<Result<(usize, SchemaPieceOrNamed), Error>>,
        n_reader_variants: usize,
        reader_null_variant: Option<usize>,
    },
    ResolveUnionConcrete {
        index: usize,
        inner: Box<SchemaPieceOrNamed>,
    },
    Record {
        doc: Documentation,
        fields: Vec<RecordField>,
        lookup: BTreeMap<String, usize>,
    },
    Enum {
        doc: Documentation,
        symbols: Vec<String>,
        default_idx: Option<usize>,
    },
    Fixed {
        size: usize,
    },
    ResolveRecord {
        defaults: Vec<ResolvedDefaultValueField>,
        fields: Vec<ResolvedRecordField>,
        n_reader_fields: usize,
    },
    ResolveEnum {
        doc: Documentation,
        symbols: Vec<Result<(usize, String), String>>,
        default: Option<(usize, String)>,
    },
}

Variants

Null

A null Avro schema.

Boolean

A boolean Avro schema.

Int

An int Avro schema.

Long

A long Avro schema.

Float

A float Avro schema.

Double

A double Avro schema.

Date

An Int Avro schema with a semantic type being days since the unix epoch.

TimestampMilli

An Int64 Avro schema with a semantic type being milliseconds since the unix epoch.

https://avro.apache.org/docs/current/spec.html#Timestamp+%28millisecond+precision%29

TimestampMicro

An Int64 Avro schema with a semantic type being microseconds since the unix epoch.

https://avro.apache.org/docs/current/spec.html#Timestamp+%28microsecond+precision%29

Decimal

A bytes or fixed Avro schema with a logical type of decimal and the specified precision and scale.

If the underlying type is fixed, the fixed_size field specifies the size.

Fields

precision: usize

scale: usize

fixed_size: Option<usize>

Bytes

A bytes Avro schema. Bytes represents a sequence of 8-bit unsigned bytes.

String

A string Avro schema. String represents a unicode character sequence.

Json

A string Avro schema that is tagged as representing JSON data

Uuid

A string Avro schema with a logical type of uuid.

Array(Box<SchemaPieceOrNamed>)

A array Avro schema. Avro arrays are required to have the same type for each element. This variant holds the Schema for the array element type.

Map(Box<SchemaPieceOrNamed>)

A map Avro schema. Map holds a pointer to the Schema of its values, which must all be the same schema. Map keys are assumed to be string.

Union(UnionSchema)

A union Avro schema.

ResolveIntTsMilli

A value written as int and read as long, for the timestamp-millis logicalType.

ResolveIntTsMicro

A value written as int and read as long, for the timestamp-micros logicalType.

ResolveDateTimestamp

A value written as an int with date logical type, and read as any timestamp type

ResolveIntLong

A value written as int and read as long

ResolveIntFloat

A value written as int and read as float

ResolveIntDouble

A value written as int and read as double

ResolveLongFloat

A value written as long and read as float

ResolveLongDouble

A value written as long and read as double

ResolveFloatDouble

A value written as float and read as double

ResolveConcreteUnion

A concrete (i.e., non-union) type in the writer, resolved against one specific variant of a union in the reader.

Fields

index: usize

The index of the variant in the reader

inner: Box<SchemaPieceOrNamed>

The concrete type

n_reader_variants: usize

reader_null_variant: Option<usize>

ResolveUnionUnion

A union in the writer, resolved against a union in the reader. The two schemas may have different variants and the variants may be in a different order.

Fields

permutation: Vec<Result<(usize, SchemaPieceOrNamed), Error>>

A mapping of the fields in the writer to those in the reader. If the ith element is Err(e), the ith field in the writer did not match any field in the reader (or even if it matched by name, resolution failed). If the ith element is Ok((j, piece)), then the ith field of the writer matched the jth field of the reader, and piece is their resolved node.

n_reader_variants: usize

reader_null_variant: Option<usize>

ResolveUnionConcrete

The inverse of ResolveConcreteUnion

Fields

index: usize

inner: Box<SchemaPieceOrNamed>

Record

A record Avro schema.

The lookup table maps field names to their position in the Vec of fields.

Fields

doc: Documentation

fields: Vec<RecordField>

lookup: BTreeMap<String, usize>

Enum

An enum Avro schema.

Fields

doc: Documentation

symbols: Vec<String>

default_idx: Option<usize>

The index of the default value.

This is only used in schema resolution: it is the value that will be read by a reader when a writer writes a value that the reader does not expect.

Fixed

A fixed Avro schema.

Fields

size: usize

ResolveRecord

A record in the writer, resolved against a record in the reader. The two schemas may have different fields and the fields may be in a different order.

Fields

defaults: Vec<ResolvedDefaultValueField>

Fields that do not exist in the writer schema, but had a default value specified in the reader schema, which we use.

fields: Vec<ResolvedRecordField>

Fields in the order of their appearance in the writer schema. Present if they could be resolved against a field in the reader schema; Absent otherwise.

n_reader_fields: usize

The size of defaults, plus the number of Present values in fields.

ResolveEnum

An enum in the writer, resolved against an enum in the reader. The two schemas may have different values and the values may be in a different order.

Fields

doc: Documentation

symbols: Vec<Result<(usize, String), String>>

Symbols in order of the writer schema along with their index in the reader schema, or Err(symbol_name) if they don’t exist in the reader schema.

default: Option<(usize, String)>

The value to decode if the writer writes some value not expected by the reader.

Implementations

impl SchemaPiece

pub fn is_underlying_int(&self) -> bool

Returns whether the schema node is “underlyingly” an Int (but possibly a logicalType typedef)

pub fn is_underlying_long(&self) -> bool

Returns whether the schema node is “underlyingly” an Int64 (but possibly a logicalType typedef)

pub fn try_make_int_value( &self, int: i32, ) -> Option<Result<AvroValue, AvroError>>

Constructs an avro::Value if this is of underlying int type. Guaranteed to be Some when is_underlying_int is true.

pub fn try_make_long_value( &self, long: i64, ) -> Option<Result<AvroValue, AvroError>>

Constructs an avro::Value if this is of underlying long type. Guaranteed to be Some when is_underlying_long is true.

Trait Implementations

impl Clone for SchemaPiece

fn clone(&self) -> SchemaPiece

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaPiece

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

Formats the value using the given formatter.

impl<'a> From<&'a SchemaPiece> for SchemaKind

fn from(piece: &'a SchemaPiece) -> SchemaKind

Converts to this type from the input type.

impl From<SchemaPiece> for SchemaPieceOrNamed

fn from(piece: SchemaPiece) -> Self

Converts to this type from the input type.

impl PartialEq for SchemaPiece

fn eq(&self, other: &SchemaPiece) -> 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 SchemaPiece