Document serde::bytes.

This commit is contained in:
Erick Tryzelaar
2015-09-01 09:49:30 -07:00
parent c14eb28223
commit 902d3a0aa5
+4 -3
View File
@@ -1,7 +1,5 @@
//! Helper module to enable serializing bytes more efficiently //! Helper module to enable serializing bytes more efficiently
#![allow(missing_docs)]
use std::ops; use std::ops;
use std::fmt; use std::fmt;
use std::ascii; use std::ascii;
@@ -62,19 +60,21 @@ impl<'a> ser::Serialize for Bytes<'a> {
/////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////
/// `ByteBuf` wraps a `Vec<u8>` in order to hook into serialize and from deserialize a byte array. /// `ByteBuf` wraps a `Vec<u8>` and serializes as a byte array.
#[derive(Clone, Eq, Hash, PartialEq, PartialOrd, Ord)] #[derive(Clone, Eq, Hash, PartialEq, PartialOrd, Ord)]
pub struct ByteBuf { pub struct ByteBuf {
bytes: Vec<u8>, bytes: Vec<u8>,
} }
impl ByteBuf { impl ByteBuf {
/// Construct a new, empty `ByteBuf`.
pub fn new() -> Self { pub fn new() -> Self {
ByteBuf { ByteBuf {
bytes: Vec::new(), bytes: Vec::new(),
} }
} }
/// Construct a new, empty `ByteBuf` with the specified capacity.
pub fn with_capacity(cap: usize) -> Self { pub fn with_capacity(cap: usize) -> Self {
ByteBuf { ByteBuf {
bytes: Vec::with_capacity(cap) bytes: Vec::with_capacity(cap)
@@ -144,6 +144,7 @@ impl ser::Serialize for ByteBuf {
} }
} }
/// This type implements the `serde::de::Visitor` trait for a `ByteBuf`.
pub struct ByteBufVisitor; pub struct ByteBufVisitor;
impl de::Visitor for ByteBufVisitor { impl de::Visitor for ByteBufVisitor {