Skip to content

Commit

Permalink
Add check that all XML events was consumed if deserialization is succ…
Browse files Browse the repository at this point in the history
…edeed
  • Loading branch information
Mingun committed Aug 22, 2021
1 parent d3cb093 commit d683c37
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 6 deletions.
2 changes: 2 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
- test: add tests for malformed inputs for serde deserializer
- fix: allow to deserialize `unit`s from any data in attribute values and text nodes
- refactor: unify errors when EOF encountered during serde deserialization
- test: ensure that after deserializing all XML was consumed
- feat: add `Deserializer::from_str` and `Deserializer::from_bytes`

## 0.23.0-alpha3

Expand Down
38 changes: 32 additions & 6 deletions src/de/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,7 @@ pub fn from_str<'de, T: Deserialize<'de>>(s: &'de str) -> Result<T, DeError> {

/// Deserialize a xml slice of bytes
pub fn from_bytes<'de, T: Deserialize<'de>>(s: &'de [u8]) -> Result<T, DeError> {
let mut reader = Reader::from_bytes(s);
reader
.expand_empty_elements(true)
.check_end_names(true)
.trim_text(true);
let mut de = Deserializer::from_borrowing_reader(SliceReader { reader });
let mut de = Deserializer::from_bytes(s);
T::deserialize(&mut de)
}

Expand Down Expand Up @@ -263,6 +258,23 @@ impl<'de, R: BorrowingReader<'de>> Deserializer<'de, R> {
}
}

impl<'de> Deserializer<'de, SliceReader<'de>> {
/// Create new deserializer that will borrow data from the specified string
pub fn from_str(s: &'de str) -> Self {
Self::from_bytes(s.as_bytes())
}

/// Create new deserializer that will borrow data from the specified byte array
pub fn from_bytes(bytes: &'de [u8]) -> Self {
let mut reader = Reader::from_bytes(bytes);
reader
.expand_empty_elements(true)
.check_end_names(true)
.trim_text(true);
Self::from_borrowing_reader(SliceReader { reader })
}
}

macro_rules! deserialize_type {
($deserialize:ident => $visit:ident) => {
fn $deserialize<V: de::Visitor<'de>>(self, visitor: V) -> Result<V::Value, DeError> {
Expand Down Expand Up @@ -560,6 +572,20 @@ mod tests {
use super::*;
use serde::Deserialize;

/// Deserialize an instance of type T from a string of XML text.
/// If deserialization was succeeded checks that all XML events was consumed
fn from_str<'de, T: Deserialize<'de>>(s: &'de str) -> Result<T, DeError> {
let mut de = Deserializer::from_str(s);
let result = T::deserialize(&mut de);

// If type was deserialized, the whole XML document should be consumed
if let Ok(_) = result {
assert_eq!(de.next().unwrap(), Event::Eof);
}

result
}

#[test]
fn read_to_end() {
use crate::events::BytesEnd;
Expand Down

0 comments on commit d683c37

Please sign in to comment.