Skip to content

fix: Union serialization #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
antonsmetanin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Union serialization #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions avro/src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,14 @@ pub enum Details {
#[error("Could not find matching type in {schema:?} for {value:?}")]
FindUnionVariant { schema: UnionSchema, value: Value },

#[error("Union index {index} out of bounds: {num_variants} in {schema:?} for {value:?}")]
UnionIndexOutOfBounds {
schema: UnionSchema,
value: Value,
index: usize,
num_variants: usize,
},

#[error("Union type should not be empty")]
EmptyUnion,

Expand Down
142 changes: 43 additions & 99 deletions avro/src/serde/ser.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,8 @@ pub struct SeqSerializer {
items: Vec<Value>,
}

pub struct SeqVariantSerializer<'a> {
pub struct SeqVariantSerializer {
index: u32,
variant: &'a str,
items: Vec<Value>,
}

Expand All @@ -46,9 +45,8 @@ pub struct StructSerializer {
fields: Vec<(String, Value)>,
}

pub struct StructVariantSerializer<'a> {
pub struct StructVariantSerializer {
index: u32,
variant: &'a str,
fields: Vec<(String, Value)>,
}

Expand All @@ -63,17 +61,13 @@ impl SeqSerializer {
}
}

impl<'a> SeqVariantSerializer<'a> {
pub fn new(index: u32, variant: &'a str, len: Option<usize>) -> SeqVariantSerializer<'a> {
impl SeqVariantSerializer {
pub fn new(index: u32, len: Option<usize>) -> SeqVariantSerializer {
let items = match len {
Some(len) => Vec::with_capacity(len),
None => Vec::new(),
};
SeqVariantSerializer {
index,
variant,
items,
}
SeqVariantSerializer { index, items }
}
}

Expand All @@ -96,26 +90,25 @@ impl StructSerializer {
}
}

impl<'a> StructVariantSerializer<'a> {
pub fn new(index: u32, variant: &'a str, len: usize) -> StructVariantSerializer<'a> {
impl StructVariantSerializer {
pub fn new(index: u32, len: usize) -> StructVariantSerializer {
StructVariantSerializer {
index,
variant,
fields: Vec::with_capacity(len),
}
}
}

impl<'b> ser::Serializer for &'b mut Serializer {
impl ser::Serializer for &mut Serializer {
type Ok = Value;
type Error = Error;
type SerializeSeq = SeqSerializer;
type SerializeTuple = SeqSerializer;
type SerializeTupleStruct = SeqSerializer;
type SerializeTupleVariant = SeqVariantSerializer<'b>;
type SerializeTupleVariant = SeqVariantSerializer;
type SerializeMap = MapSerializer;
type SerializeStruct = StructSerializer;
type SerializeStructVariant = StructVariantSerializer<'b>;
type SerializeStructVariant = StructVariantSerializer;

fn serialize_bool(self, v: bool) -> Result<Self::Ok, Self::Error> {
Ok(Value::Boolean(v))
Expand Down Expand Up @@ -226,21 +219,15 @@ impl<'b> ser::Serializer for &'b mut Serializer {

fn serialize_newtype_variant<T>(
self,
_: &'static str,
_name: &'static str,
index: u32,
variant: &'static str,
_variant: &'static str,
value: &T,
) -> Result<Self::Ok, Self::Error>
where
T: Serialize + ?Sized,
{
Ok(Value::Record(vec![
("type".to_owned(), Value::Enum(index, variant.to_owned())),
(
"value".to_owned(),
Value::Union(index, Box::new(value.serialize(self)?)),
),
]))
Ok(Value::Union(index, Box::new(value.serialize(self)?)))
}

fn serialize_seq(self, len: Option<usize>) -> Result<Self::SerializeSeq, Self::Error> {
Expand All @@ -261,12 +248,12 @@ impl<'b> ser::Serializer for &'b mut Serializer {

fn serialize_tuple_variant(
self,
_: &'static str,
_name: &'static str,
index: u32,
variant: &'static str,
_variant: &'static str,
len: usize,
) -> Result<Self::SerializeTupleVariant, Self::Error> {
Ok(SeqVariantSerializer::new(index, variant, Some(len)))
Ok(SeqVariantSerializer::new(index, Some(len)))
}

fn serialize_map(self, len: Option<usize>) -> Result<Self::SerializeMap, Self::Error> {
Expand All @@ -283,12 +270,12 @@ impl<'b> ser::Serializer for &'b mut Serializer {

fn serialize_struct_variant(
self,
_: &'static str,
_name: &'static str,
index: u32,
variant: &'static str,
_variant: &'static str,
len: usize,
) -> Result<Self::SerializeStructVariant, Self::Error> {
Ok(StructVariantSerializer::new(index, variant, len))
Ok(StructVariantSerializer::new(index, len))
}

fn is_human_readable(&self) -> bool {
Expand Down Expand Up @@ -346,11 +333,11 @@ impl ser::SerializeTupleStruct for SeqSerializer {
}
}

impl ser::SerializeSeq for SeqVariantSerializer<'_> {
impl ser::SerializeTupleVariant for SeqVariantSerializer {
type Ok = Value;
type Error = Error;

fn serialize_element<T>(&mut self, value: &T) -> Result<(), Self::Error>
fn serialize_field<T>(&mut self, value: &T) -> Result<(), Self::Error>
where
T: Serialize + ?Sized,
{
Expand All @@ -362,29 +349,7 @@ impl ser::SerializeSeq for SeqVariantSerializer<'_> {
}

fn end(self) -> Result<Self::Ok, Self::Error> {
Ok(Value::Record(vec![
(
"type".to_owned(),
Value::Enum(self.index, self.variant.to_owned()),
),
("value".to_owned(), Value::Array(self.items)),
]))
}
}

impl ser::SerializeTupleVariant for SeqVariantSerializer<'_> {
type Ok = Value;
type Error = Error;

fn serialize_field<T>(&mut self, value: &T) -> Result<(), Self::Error>
where
T: Serialize + ?Sized,
{
ser::SerializeSeq::serialize_element(self, value)
}

fn end(self) -> Result<Self::Ok, Self::Error> {
ser::SerializeSeq::end(self)
Ok(Value::Union(self.index, Box::new(Value::Array(self.items))))
}
}

Expand Down Expand Up @@ -447,7 +412,7 @@ impl ser::SerializeStruct for StructSerializer {
}
}

impl ser::SerializeStructVariant for StructVariantSerializer<'_> {
impl ser::SerializeStructVariant for StructVariantSerializer {
type Ok = Value;
type Error = Error;

Expand All @@ -463,16 +428,10 @@ impl ser::SerializeStructVariant for StructVariantSerializer<'_> {
}

fn end(self) -> Result<Self::Ok, Self::Error> {
Ok(Value::Record(vec![
(
"type".to_owned(),
Value::Enum(self.index, self.variant.to_owned()),
),
(
"value".to_owned(),
Value::Union(self.index, Box::new(Value::Record(self.fields))),
),
]))
Ok(Value::Union(
self.index,
Box::new(Value::Record(self.fields)),
))
}
}

Expand Down Expand Up @@ -789,13 +748,7 @@ mod tests {

let expected = Value::Record(vec![(
"a".to_owned(),
Value::Record(vec![
("type".to_owned(), Value::Enum(0, "Double".to_owned())),
(
"value".to_owned(),
Value::Union(0, Box::new(Value::Double(64.0))),
),
]),
Value::Union(0, Box::new(Value::Double(64.0))),
)]);

assert_eq!(
Expand Down Expand Up @@ -851,19 +804,13 @@ mod tests {
};
let expected = Value::Record(vec![(
"a".to_owned(),
Value::Record(vec![
("type".to_owned(), Value::Enum(0, "Val1".to_owned())),
(
"value".to_owned(),
Value::Union(
0,
Box::new(Value::Record(vec![
("x".to_owned(), Value::Float(1.0)),
("y".to_owned(), Value::Float(2.0)),
])),
),
),
]),
Value::Union(
0,
Box::new(Value::Record(vec![
("x".to_owned(), Value::Float(1.0)),
("y".to_owned(), Value::Float(2.0)),
])),
),
)]);

assert_eq!(
Expand Down Expand Up @@ -965,17 +912,14 @@ mod tests {

let expected = Value::Record(vec![(
"a".to_owned(),
Value::Record(vec![
("type".to_owned(), Value::Enum(1, "Val2".to_owned())),
(
"value".to_owned(),
Value::Array(vec![
Value::Union(1, Box::new(Value::Float(1.0))),
Value::Union(1, Box::new(Value::Float(2.0))),
Value::Union(1, Box::new(Value::Float(3.0))),
]),
),
]),
Value::Union(
1,
Box::new(Value::Array(vec![
Value::Union(1, Box::new(Value::Float(1.0))),
Value::Union(1, Box::new(Value::Float(2.0))),
Value::Union(1, Box::new(Value::Float(3.0))),
])),
),
)]);

assert_eq!(
Expand Down
40 changes: 28 additions & 12 deletions avro/src/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1024,18 +1024,34 @@ impl Value {
enclosing_namespace: &Namespace,
field_default: &Option<JsonValue>,
) -> Result<Self, Error> {
let v = match self {
// Both are unions case.
Value::Union(_i, v) => *v,
// Reader is a union, but writer is not.
v => v,
};
let (i, inner) = schema
.find_schema_with_known_schemata(&v, Some(names), enclosing_namespace)
.ok_or_else(|| Details::FindUnionVariant {
schema: schema.clone(),
value: v.clone(),
})?;
let (i, inner, v) =
match self {
// Both are unions case.
Value::Union(i, v) => {
let index = i as usize;
let inner = schema.schemas.get(index).ok_or_else(|| {
Details::UnionIndexOutOfBounds {
schema: schema.clone(),
value: *v.clone(),
index,
num_variants: schema.schemas.len(),
}
})?;

(index, inner, *v)
}
// Reader is a union, but writer is not.
v => {
let (i, inner) = schema
.find_schema_with_known_schemata(&v, Some(names), enclosing_namespace)
.ok_or_else(|| Details::FindUnionVariant {
schema: schema.clone(),
value: v.clone(),
})?;

(i, inner, v)
}
};

Ok(Value::Union(
i as u32,
Expand Down
Loading