3 releases (breaking)

0.16.0 Sep 26, 2023
0.15.0 Jul 10, 2023
0.14.0 Aug 3, 2022

#1714 in Encoding

Download history 8319/week @ 2023-11-20 10439/week @ 2023-11-27 8328/week @ 2023-12-04 8122/week @ 2023-12-11 8568/week @ 2023-12-18 8060/week @ 2023-12-25 6597/week @ 2024-01-01 10062/week @ 2024-01-08 7213/week @ 2024-01-15 6322/week @ 2024-01-22 5060/week @ 2024-01-29 4916/week @ 2024-02-05 2964/week @ 2024-02-12 4345/week @ 2024-02-19 5026/week @ 2024-02-26 3617/week @ 2024-03-04

16,270 downloads per month
Used in 6 crates (via apache-avro)

Apache-2.0

26KB
468 lines

avro_derive

A proc-macro module for automatically deriving the avro schema for structs or enums. The macro produces the logic necessary to implement the AvroSchema trait for the type.

pub trait AvroSchema {
    // constructs the schema for the type
    fn get_schema() -> Schema;
}

How-to use

Add the "derive" feature to your apache-avro dependency inside cargo.toml

apache-avro = { version = "X.Y.Z", features = ["derive"] }

Add to your data model

#[derive(AvroSchema)]
struct Test {
    a: i64,
    b: String,
}

Example

use apache_avro::Writer;

#[derive(Debug, Serialize, AvroSchema)]
struct Test {
    a: i64,
    b: String,
}
// derived schema, always valid or code fails to compile with a descriptive message
let schema = Test::get_schema();

let mut writer = Writer::new(&schema, Vec::new());
let test = Test {
    a: 27,
    b: "foo".to_owned(),
};
writer.append_ser(test).unwrap();
let encoded = writer.into_inner();

Compatibility Notes

This module is designed to work in concert with the Serde implemenation. If your use case dictates needing to manually convert to a Value type in order to encode then the derived schema may not be correct.

Dependencies

~1–1.8MB
~40K SLoC