From 25cfb15823f1caf9f605ab41450e3ad695aa67eb Mon Sep 17 00:00:00 2001 From: Ty Overby Date: Sun, 7 Feb 2016 16:46:23 -0800 Subject: [PATCH] add more docs --- src/rustc_serialize/reader.rs | 7 +++++++ src/serde/reader.rs | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/src/rustc_serialize/reader.rs b/src/rustc_serialize/reader.rs index 0b3d013..0108ec5 100644 --- a/src/rustc_serialize/reader.rs +++ b/src/rustc_serialize/reader.rs @@ -100,6 +100,13 @@ impl From for DecodingError { /// /// This struct should rarely be used. /// In most cases, prefer the `decode_from` function. +/// +/// ```no_run +/// let file = ... +/// let dr = bincode::rustc_serialize::DecoderReader::new(&mut file, SizeLimit::Infinite); +/// let result: T = Decodable::decode(&mut dr); +/// let bytes_red = dr.bytes_read(); +/// ``` pub struct DecoderReader<'a, R: 'a> { reader: &'a mut R, size_limit: SizeLimit, diff --git a/src/serde/reader.rs b/src/serde/reader.rs index f47fa81..ff0c8cf 100644 --- a/src/serde/reader.rs +++ b/src/serde/reader.rs @@ -154,6 +154,13 @@ pub type DeserializeResult = Result; /// /// This struct should rarely be used. /// In most cases, prefer the `decode_from` function. +/// +/// ```no_run +/// let file = ... +/// let d = Deserializer::new(&mut file, SizeLimit::new()); +/// serde::Deserialize::deserialize(&mut deserializer); +/// let bytes_read = d.bytes_read(); +/// ``` pub struct Deserializer<'a, R: 'a> { reader: &'a mut R, size_limit: SizeLimit,