lib{serialize, uuid}: Fix snake case errors.

A number of functions/methods have been moved or renamed to align
better with rust standard conventions.

serialize::ebml::reader::Doc => seriaize::ebml::Doc::new
serialize::ebml::reader::Decoder => Decoder::new
serialize::ebml::writer::Encoder => Encoder::new

[breaking-change]
This commit is contained in:
Kevin Butler 2014-05-26 02:32:04 +01:00
parent 3faa6762c1
commit ed5bf6621e
5 changed files with 38 additions and 33 deletions

View File

@ -26,6 +26,10 @@ pub struct Doc<'a> {
} }
impl<'doc> Doc<'doc> { impl<'doc> Doc<'doc> {
pub fn new(data: &'doc [u8]) -> Doc<'doc> {
Doc { data: data, start: 0u, end: data.len() }
}
pub fn get<'a>(&'a self, tag: uint) -> Doc<'a> { pub fn get<'a>(&'a self, tag: uint) -> Doc<'a> {
reader::get_doc(*self, tag) reader::get_doc(*self, tag)
} }
@ -192,10 +196,6 @@ pub mod reader {
} }
} }
pub fn Doc<'a>(data: &'a [u8]) -> Doc<'a> {
Doc { data: data, start: 0u, end: data.len() }
}
pub fn doc_at<'a>(data: &'a [u8], start: uint) -> DecodeResult<TaggedDoc<'a>> { pub fn doc_at<'a>(data: &'a [u8], start: uint) -> DecodeResult<TaggedDoc<'a>> {
let elt_tag = try!(vuint_at(data, start)); let elt_tag = try!(vuint_at(data, start));
let elt_size = try!(vuint_at(data, elt_tag.next)); let elt_size = try!(vuint_at(data, elt_tag.next));
@ -296,14 +296,14 @@ pub mod reader {
pos: uint, pos: uint,
} }
pub fn Decoder<'a>(d: Doc<'a>) -> Decoder<'a> {
Decoder {
parent: d,
pos: d.start
}
}
impl<'doc> Decoder<'doc> { impl<'doc> Decoder<'doc> {
pub fn new(d: Doc<'doc>) -> Decoder<'doc> {
Decoder {
parent: d,
pos: d.start
}
}
fn _check_label(&mut self, lbl: &str) -> DecodeResult<()> { fn _check_label(&mut self, lbl: &str) -> DecodeResult<()> {
if self.pos < self.parent.end { if self.pos < self.parent.end {
let TaggedDoc { tag: r_tag, doc: r_doc } = let TaggedDoc { tag: r_tag, doc: r_doc } =
@ -673,15 +673,15 @@ pub mod writer {
}) })
} }
pub fn Encoder<'a, W: Writer + Seek>(w: &'a mut W) -> Encoder<'a, W> {
Encoder {
writer: w,
size_positions: vec!(),
}
}
// FIXME (#2741): Provide a function to write the standard ebml header. // FIXME (#2741): Provide a function to write the standard ebml header.
impl<'a, W: Writer + Seek> Encoder<'a, W> { impl<'a, W: Writer + Seek> Encoder<'a, W> {
pub fn new(w: &'a mut W) -> Encoder<'a, W> {
Encoder {
writer: w,
size_positions: vec!(),
}
}
/// FIXME(pcwalton): Workaround for badness in trans. DO NOT USE ME. /// FIXME(pcwalton): Workaround for badness in trans. DO NOT USE ME.
pub unsafe fn unsafe_clone(&self) -> Encoder<'a, W> { pub unsafe fn unsafe_clone(&self) -> Encoder<'a, W> {
Encoder { Encoder {
@ -1020,6 +1020,7 @@ pub mod writer {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::Doc;
use ebml::reader; use ebml::reader;
use ebml::writer; use ebml::writer;
use {Encodable, Decodable}; use {Encodable, Decodable};
@ -1081,11 +1082,11 @@ mod tests {
debug!("v == {}", v); debug!("v == {}", v);
let mut wr = MemWriter::new(); let mut wr = MemWriter::new();
{ {
let mut ebml_w = writer::Encoder(&mut wr); let mut ebml_w = writer::Encoder::new(&mut wr);
let _ = v.encode(&mut ebml_w); let _ = v.encode(&mut ebml_w);
} }
let ebml_doc = reader::Doc(wr.get_ref()); let ebml_doc = Doc::new(wr.get_ref());
let mut deser = reader::Decoder(ebml_doc); let mut deser = reader::Decoder::new(ebml_doc);
let v1 = Decodable::decode(&mut deser).unwrap(); let v1 = Decodable::decode(&mut deser).unwrap();
debug!("v1 == {}", v1); debug!("v1 == {}", v1);
assert_eq!(v, v1); assert_eq!(v, v1);
@ -1099,6 +1100,7 @@ mod tests {
#[cfg(test)] #[cfg(test)]
mod bench { mod bench {
#![allow(non_snake_case_functions)]
extern crate test; extern crate test;
use self::test::Bencher; use self::test::Bencher;
use ebml::reader; use ebml::reader;

View File

@ -1,4 +1,4 @@
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT // Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at // file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT. // http://rust-lang.org/COPYRIGHT.
// //
@ -795,14 +795,16 @@ mod test {
#[test] #[test]
fn test_serialize_round_trip() { fn test_serialize_round_trip() {
use serialize::ebml; use serialize::ebml::Doc;
use serialize::ebml::writer::Encoder;
use serialize::ebml::reader::Decoder;
use serialize::{Encodable, Decodable}; use serialize::{Encodable, Decodable};
let u = Uuid::new_v4(); let u = Uuid::new_v4();
let mut wr = MemWriter::new(); let mut wr = MemWriter::new();
let _ = u.encode(&mut ebml::writer::Encoder(&mut wr)); let _ = u.encode(&mut Encoder::new(&mut wr));
let doc = ebml::reader::Doc(wr.get_ref()); let doc = Doc::new(wr.get_ref());
let u2 = Decodable::decode(&mut ebml::reader::Decoder(doc)).unwrap(); let u2 = Decodable::decode(&mut Decoder::new(doc)).unwrap();
assert_eq!(u, u2); assert_eq!(u, u2);
} }

View File

@ -33,12 +33,12 @@ fn test_ebml<'a, 'b, A:
Decodable<EBReader::Decoder<'b>> Decodable<EBReader::Decoder<'b>>
>(a1: &A) { >(a1: &A) {
let mut wr = std::io::MemWriter::new(); let mut wr = std::io::MemWriter::new();
let mut ebml_w = EBWriter::Encoder(&mut wr); let mut ebml_w = EBwriter::Encoder::new(&mut wr);
a1.encode(&mut ebml_w); a1.encode(&mut ebml_w);
let bytes = wr.get_ref(); let bytes = wr.get_ref();
let d: serialize::ebml::Doc<'a> = EBReader::Doc(bytes); let d: serialize::ebml::Doc<'a> = EBDoc::new(bytes);
let mut decoder: EBReader::Decoder<'a> = EBReader::Decoder(d); let mut decoder: EBReader::Decoder<'a> = EBreader::Decoder::new(d);
let a2: A = Decodable::decode(&mut decoder); let a2: A = Decodable::decode(&mut decoder);
assert!(*a1 == a2); assert!(*a1 == a2);
} }

View File

@ -22,6 +22,7 @@ use std::io::MemWriter;
use rand::{random, Rand}; use rand::{random, Rand};
use serialize::{Encodable, Decodable}; use serialize::{Encodable, Decodable};
use serialize::ebml; use serialize::ebml;
use serialize::ebml::Doc;
use serialize::ebml::writer::Encoder; use serialize::ebml::writer::Encoder;
use serialize::ebml::reader::Decoder; use serialize::ebml::reader::Decoder;
@ -58,10 +59,10 @@ fn roundtrip<'a, T: Rand + Eq + Encodable<Encoder<'a>> +
Decodable<Decoder<'a>>>() { Decodable<Decoder<'a>>>() {
let obj: T = random(); let obj: T = random();
let mut w = MemWriter::new(); let mut w = MemWriter::new();
let mut e = Encoder(&mut w); let mut e = Encoder::new(&mut w);
obj.encode(&mut e); obj.encode(&mut e);
let doc = ebml::reader::Doc(@w.get_ref()); let doc = ebml::Doc::new(@w.get_ref());
let mut dec = Decoder(doc); let mut dec = Decoder::new(doc);
let obj2 = Decodable::decode(&mut dec); let obj2 = Decodable::decode(&mut dec);
assert!(obj == obj2); assert!(obj == obj2);
} }

View File

@ -43,7 +43,7 @@ fn encode_ebml<'a,
T: Encodable<writer::Encoder<'a, MemWriter>, T: Encodable<writer::Encoder<'a, MemWriter>,
std::io::IoError>>(val: &T, std::io::IoError>>(val: &T,
wr: &'a mut MemWriter) { wr: &'a mut MemWriter) {
let mut encoder = writer::Encoder(wr); let mut encoder = writer::Encoder::new(wr);
val.encode(&mut encoder); val.encode(&mut encoder);
} }