diff options
| -rw-r--r-- | src/de.rs | 3 | ||||
| -rw-r--r-- | src/lib.rs | 11 | ||||
| -rw-r--r-- | src/ser.rs | 3 |
3 files changed, 10 insertions, 7 deletions
@@ -386,7 +386,8 @@ where } } -pub fn deserialize<R: Read + Seek, T: de::DeserializeOwned>(reader: R) -> Result<T, Error> { +/// Deserializes an instance of type `T` from a seekable byte stream. +pub fn from_reader<R: Read + Seek, T: de::DeserializeOwned>(reader: R) -> Result<T, Error> { let reader = events::Reader::new(reader); let mut de = Deserializer::new(reader); de::Deserialize::deserialize(&mut de) @@ -20,6 +20,8 @@ //! ## Examples //! //! ```rust +//! extern crate plist; +//! //! use plist::Value; //! use std::fs::File; //! @@ -33,14 +35,13 @@ //! ``` //! //! ```rust +//! extern crate plist; //! # #[cfg(feature = "serde")] //! #[macro_use] //! extern crate serde_derive; -//! # extern crate plist; //! //! # #[cfg(feature = "serde")] //! # fn main() { -//! use plist::deserialize; //! use std::fs::File; //! //! #[derive(Deserialize)] @@ -51,7 +52,7 @@ //! } //! //! let file = File::open("tests/data/xml.plist").unwrap(); -//! let info: Info = deserialize(file).unwrap(); +//! let info: Info = plist::from_reader(file).unwrap(); //! # } //! # //! # #[cfg(not(feature = "serde"))] @@ -80,9 +81,9 @@ mod de; #[cfg(feature = "serde")] mod ser; #[cfg(feature = "serde")] -pub use self::de::{deserialize, Deserializer}; +pub use self::de::{from_reader, Deserializer}; #[cfg(feature = "serde")] -pub use self::ser::{serialize_to_xml, Serializer}; +pub use self::ser::{to_writer_xml, Serializer}; use std::fmt; use std::io; @@ -705,7 +705,8 @@ impl<'a, W: Writer> ser::SerializeStructVariant for Compound<'a, W> { } } -pub fn serialize_to_xml<W: Write, T: ser::Serialize>(writer: W, value: &T) -> Result<(), Error> { +/// Serializes the given data structure as an XML encoded plist file. +pub fn to_writer_xml<W: Write, T: ser::Serialize>(writer: W, value: &T) -> Result<(), Error> { let writer = events::XmlWriter::new(writer); let mut ser = Serializer::new(writer); value.serialize(&mut ser) |
