// Copyright 2017 Serde Developers // // Licensed under the Apache License, Version 2.0 or the MIT license // , at your // option. This file may not be copied, modified, or distributed // except according to those terms. use serde::{ser, Serialize}; use error::Error; use token::Token; /// A `Serializer` that ensures that a value serializes to a given list of tokens. #[derive(Debug)] pub struct Serializer<'a> { tokens: &'a [Token], is_human_readable: bool, } impl<'a> Serializer<'a> { /// Creates the serializer. pub fn new(tokens: &'a [Token]) -> Self { Serializer::readable(tokens, true) } pub fn readable(tokens: &'a [Token], is_human_readable: bool) -> Self { Serializer { tokens: tokens, is_human_readable: is_human_readable } } /// Pulls the next token off of the serializer, ignoring it. fn next_token(&mut self) -> Option { if let Some((&first, rest)) = self.tokens.split_first() { self.tokens = rest; Some(first) } else { None } } pub fn remaining(&self) -> usize { self.tokens.len() } } macro_rules! assert_next_token { ($ser:expr, $expected:ident) => { assert_next_token!($ser, $expected, Token::$expected, true); }; ($ser:expr, $expected:ident($v:expr)) => { assert_next_token!($ser, $expected, Token::$expected(v), v == $v); }; ($ser:expr, $expected:ident { $($k:ident),* }) => { let compare = ($($k,)*); assert_next_token!($ser, $expected, Token::$expected { $($k),* }, ($($k,)*) == compare); }; ($ser:expr, $expected:ident, $pat:pat, $guard:expr) => { match $ser.next_token() { Some($pat) if $guard => {} Some(other) => { panic!("expected Token::{} but serialized as {}", stringify!($expected), other); } None => { panic!("expected Token::{} after end of serialized tokens", stringify!($expected)); } } }; } impl<'s, 'a> ser::Serializer for &'s mut Serializer<'a> { type Ok = (); type Error = Error; type SerializeSeq = Self; type SerializeTuple = Self; type SerializeTupleStruct = Self; type SerializeTupleVariant = Variant<'s, 'a>; type SerializeMap = Self; type SerializeStruct = Self; type SerializeStructVariant = Variant<'s, 'a>; fn serialize_bool(self, v: bool) -> Result<(), Error> { assert_next_token!(self, Bool(v)); Ok(()) } fn serialize_i8(self, v: i8) -> Result<(), Error> { assert_next_token!(self, I8(v)); Ok(()) } fn serialize_i16(self, v: i16) -> Result<(), Error> { assert_next_token!(self, I16(v)); Ok(()) } fn serialize_i32(self, v: i32) -> Result<(), Error> { assert_next_token!(self, I32(v)); Ok(()) } fn serialize_i64(self, v: i64) -> Result<(), Error> { assert_next_token!(self, I64(v)); Ok(()) } fn serialize_u8(self, v: u8) -> Result<(), Error> { assert_next_token!(self, U8(v)); Ok(()) } fn serialize_u16(self, v: u16) -> Result<(), Error> { assert_next_token!(self, U16(v)); Ok(()) } fn serialize_u32(self, v: u32) -> Result<(), Error> { assert_next_token!(self, U32(v)); Ok(()) } fn serialize_u64(self, v: u64) -> Result<(), Error> { assert_next_token!(self, U64(v)); Ok(()) } fn serialize_f32(self, v: f32) -> Result<(), Error> { assert_next_token!(self, F32(v)); Ok(()) } fn serialize_f64(self, v: f64) -> Result<(), Error> { assert_next_token!(self, F64(v)); Ok(()) } fn serialize_char(self, v: char) -> Result<(), Error> { assert_next_token!(self, Char(v)); Ok(()) } fn serialize_str(self, v: &str) -> Result<(), Error> { match self.tokens.first() { Some(&Token::BorrowedStr(_)) => assert_next_token!(self, BorrowedStr(v)), Some(&Token::String(_)) => assert_next_token!(self, String(v)), _ => assert_next_token!(self, Str(v)), } Ok(()) } fn serialize_bytes(self, v: &[u8]) -> Result<(), Self::Error> { match self.tokens.first() { Some(&Token::BorrowedBytes(_)) => assert_next_token!(self, BorrowedBytes(v)), Some(&Token::ByteBuf(_)) => assert_next_token!(self, ByteBuf(v)), _ => assert_next_token!(self, Bytes(v)), } Ok(()) } fn serialize_unit(self) -> Result<(), Error> { assert_next_token!(self, Unit); Ok(()) } fn serialize_unit_struct(self, name: &'static str) -> Result<(), Error> { assert_next_token!(self, UnitStruct { name }); Ok(()) } fn serialize_unit_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, ) -> Result<(), Error> { if self.tokens.first() == Some(&Token::Enum { name: name }) { self.next_token(); assert_next_token!(self, Str(variant)); assert_next_token!(self, Unit); } else { assert_next_token!(self, UnitVariant { name, variant }); } Ok(()) } fn serialize_newtype_struct(self, name: &'static str, value: &T) -> Result<(), Error> where T: Serialize, { assert_next_token!(self, NewtypeStruct { name }); value.serialize(self) } fn serialize_newtype_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, value: &T, ) -> Result<(), Error> where T: Serialize, { if self.tokens.first() == Some(&Token::Enum { name: name }) { self.next_token(); assert_next_token!(self, Str(variant)); } else { assert_next_token!(self, NewtypeVariant { name, variant }); } value.serialize(self) } fn serialize_none(self) -> Result<(), Error> { assert_next_token!(self, None); Ok(()) } fn serialize_some(self, value: &T) -> Result<(), Error> where T: Serialize, { assert_next_token!(self, Some); value.serialize(self) } fn serialize_seq(self, len: Option) -> Result { assert_next_token!(self, Seq { len }); Ok(self) } fn serialize_tuple(self, len: usize) -> Result { assert_next_token!(self, Tuple { len }); Ok(self) } fn serialize_tuple_struct(self, name: &'static str, len: usize) -> Result { assert_next_token!(self, TupleStruct { name, len }); Ok(self) } fn serialize_tuple_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, len: usize, ) -> Result { if self.tokens.first() == Some(&Token::Enum { name: name }) { self.next_token(); assert_next_token!(self, Str(variant)); let len = Some(len); assert_next_token!(self, Seq { len }); Ok(Variant { ser: self, end: Token::SeqEnd }) } else { assert_next_token!(self, TupleVariant { name, variant, len }); Ok(Variant { ser: self, end: Token::TupleVariantEnd }) } } fn serialize_map(self, len: Option) -> Result { assert_next_token!(self, Map { len }); Ok(self) } fn serialize_struct(self, name: &'static str, len: usize) -> Result { assert_next_token!(self, Struct { name, len }); Ok(self) } fn serialize_struct_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, len: usize, ) -> Result { if self.tokens.first() == Some(&Token::Enum { name: name }) { self.next_token(); assert_next_token!(self, Str(variant)); let len = Some(len); assert_next_token!(self, Map { len }); Ok(Variant { ser: self, end: Token::MapEnd }) } else { assert_next_token!(self, StructVariant { name, variant, len }); Ok(Variant { ser: self, end: Token::StructVariantEnd }) } } fn is_human_readable(&self) -> bool { self.is_human_readable } } pub struct Variant<'s, 'a: 's> { ser: &'s mut Serializer<'a>, end: Token, } impl<'s, 'a> ser::SerializeSeq for &'s mut Serializer<'a> { type Ok = (); type Error = Error; fn serialize_element(&mut self, value: &T) -> Result<(), Error> where T: Serialize, { value.serialize(&mut **self) } fn end(self) -> Result<(), Error> { assert_next_token!(self, SeqEnd); Ok(()) } } impl<'s, 'a> ser::SerializeTuple for &'s mut Serializer<'a> { type Ok = (); type Error = Error; fn serialize_element(&mut self, value: &T) -> Result<(), Error> where T: Serialize, { value.serialize(&mut **self) } fn end(self) -> Result<(), Error> { assert_next_token!(self, TupleEnd); Ok(()) } } impl<'s, 'a> ser::SerializeTupleStruct for &'s mut Serializer<'a> { type Ok = (); type Error = Error; fn serialize_field(&mut self, value: &T) -> Result<(), Error> where T: Serialize, { value.serialize(&mut **self) } fn end(self) -> Result<(), Error> { assert_next_token!(self, TupleStructEnd); Ok(()) } } impl<'s, 'a> ser::SerializeTupleVariant for Variant<'s, 'a> { type Ok = (); type Error = Error; fn serialize_field(&mut self, value: &T) -> Result<(), Error> where T: Serialize, { value.serialize(&mut *self.ser) } fn end(self) -> Result<(), Error> { match self.end { Token::TupleVariantEnd => assert_next_token!(self.ser, TupleVariantEnd), Token::SeqEnd => assert_next_token!(self.ser, SeqEnd), _ => unreachable!(), } Ok(()) } } impl<'s, 'a> ser::SerializeMap for &'s mut Serializer<'a> { type Ok = (); type Error = Error; fn serialize_key(&mut self, key: &T) -> Result<(), Self::Error> where T: Serialize, { key.serialize(&mut **self) } fn serialize_value(&mut self, value: &T) -> Result<(), Self::Error> where T: Serialize, { value.serialize(&mut **self) } fn end(self) -> Result<(), Self::Error> { assert_next_token!(self, MapEnd); Ok(()) } } impl<'s, 'a> ser::SerializeStruct for &'s mut Serializer<'a> { type Ok = (); type Error = Error; fn serialize_field( &mut self, key: &'static str, value: &T, ) -> Result<(), Self::Error> where T: Serialize, { try!(key.serialize(&mut **self)); value.serialize(&mut **self) } fn end(self) -> Result<(), Self::Error> { assert_next_token!(self, StructEnd); Ok(()) } } impl<'s, 'a> ser::SerializeStructVariant for Variant<'s, 'a> { type Ok = (); type Error = Error; fn serialize_field( &mut self, key: &'static str, value: &T, ) -> Result<(), Self::Error> where T: Serialize, { try!(key.serialize(&mut *self.ser)); value.serialize(&mut *self.ser) } fn end(self) -> Result<(), Self::Error> { match self.end { Token::StructVariantEnd => assert_next_token!(self.ser, StructVariantEnd), Token::MapEnd => assert_next_token!(self.ser, MapEnd), _ => unreachable!(), } Ok(()) } }