Skip to content

Commit ed5bf66

Browse files
committed
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]
1 parent 3faa676 commit ed5bf66

File tree

5 files changed

+37
-32
lines changed

5 files changed

+37
-32
lines changed

src/libserialize/ebml.rs

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ pub struct Doc<'a> {
2626
}
2727

2828
impl<'doc> Doc<'doc> {
29+
pub fn new(data: &'doc [u8]) -> Doc<'doc> {
30+
Doc { data: data, start: 0u, end: data.len() }
31+
}
32+
2933
pub fn get<'a>(&'a self, tag: uint) -> Doc<'a> {
3034
reader::get_doc(*self, tag)
3135
}
@@ -192,10 +196,6 @@ pub mod reader {
192196
}
193197
}
194198

195-
pub fn Doc<'a>(data: &'a [u8]) -> Doc<'a> {
196-
Doc { data: data, start: 0u, end: data.len() }
197-
}
198-
199199
pub fn doc_at<'a>(data: &'a [u8], start: uint) -> DecodeResult<TaggedDoc<'a>> {
200200
let elt_tag = try!(vuint_at(data, start));
201201
let elt_size = try!(vuint_at(data, elt_tag.next));
@@ -296,14 +296,14 @@ pub mod reader {
296296
pos: uint,
297297
}
298298

299-
pub fn Decoder<'a>(d: Doc<'a>) -> Decoder<'a> {
300-
Decoder {
301-
parent: d,
302-
pos: d.start
299+
impl<'doc> Decoder<'doc> {
300+
pub fn new(d: Doc<'doc>) -> Decoder<'doc> {
301+
Decoder {
302+
parent: d,
303+
pos: d.start
304+
}
303305
}
304-
}
305306

306-
impl<'doc> Decoder<'doc> {
307307
fn _check_label(&mut self, lbl: &str) -> DecodeResult<()> {
308308
if self.pos < self.parent.end {
309309
let TaggedDoc { tag: r_tag, doc: r_doc } =
@@ -673,15 +673,15 @@ pub mod writer {
673673
})
674674
}
675675

676-
pub fn Encoder<'a, W: Writer + Seek>(w: &'a mut W) -> Encoder<'a, W> {
677-
Encoder {
678-
writer: w,
679-
size_positions: vec!(),
680-
}
681-
}
682-
683676
// FIXME (#2741): Provide a function to write the standard ebml header.
684677
impl<'a, W: Writer + Seek> Encoder<'a, W> {
678+
pub fn new(w: &'a mut W) -> Encoder<'a, W> {
679+
Encoder {
680+
writer: w,
681+
size_positions: vec!(),
682+
}
683+
}
684+
685685
/// FIXME(pcwalton): Workaround for badness in trans. DO NOT USE ME.
686686
pub unsafe fn unsafe_clone(&self) -> Encoder<'a, W> {
687687
Encoder {
@@ -1020,6 +1020,7 @@ pub mod writer {
10201020

10211021
#[cfg(test)]
10221022
mod tests {
1023+
use super::Doc;
10231024
use ebml::reader;
10241025
use ebml::writer;
10251026
use {Encodable, Decodable};
@@ -1081,11 +1082,11 @@ mod tests {
10811082
debug!("v == {}", v);
10821083
let mut wr = MemWriter::new();
10831084
{
1084-
let mut ebml_w = writer::Encoder(&mut wr);
1085+
let mut ebml_w = writer::Encoder::new(&mut wr);
10851086
let _ = v.encode(&mut ebml_w);
10861087
}
1087-
let ebml_doc = reader::Doc(wr.get_ref());
1088-
let mut deser = reader::Decoder(ebml_doc);
1088+
let ebml_doc = Doc::new(wr.get_ref());
1089+
let mut deser = reader::Decoder::new(ebml_doc);
10891090
let v1 = Decodable::decode(&mut deser).unwrap();
10901091
debug!("v1 == {}", v1);
10911092
assert_eq!(v, v1);
@@ -1099,6 +1100,7 @@ mod tests {
10991100

11001101
#[cfg(test)]
11011102
mod bench {
1103+
#![allow(non_snake_case_functions)]
11021104
extern crate test;
11031105
use self::test::Bencher;
11041106
use ebml::reader;

src/libuuid/lib.rs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
1+
// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
22
// file at the top-level directory of this distribution and at
33
// http://rust-lang.org/COPYRIGHT.
44
//
@@ -795,14 +795,16 @@ mod test {
795795

796796
#[test]
797797
fn test_serialize_round_trip() {
798-
use serialize::ebml;
798+
use serialize::ebml::Doc;
799+
use serialize::ebml::writer::Encoder;
800+
use serialize::ebml::reader::Decoder;
799801
use serialize::{Encodable, Decodable};
800802

801803
let u = Uuid::new_v4();
802804
let mut wr = MemWriter::new();
803-
let _ = u.encode(&mut ebml::writer::Encoder(&mut wr));
804-
let doc = ebml::reader::Doc(wr.get_ref());
805-
let u2 = Decodable::decode(&mut ebml::reader::Decoder(doc)).unwrap();
805+
let _ = u.encode(&mut Encoder::new(&mut wr));
806+
let doc = Doc::new(wr.get_ref());
807+
let u2 = Decodable::decode(&mut Decoder::new(doc)).unwrap();
806808
assert_eq!(u, u2);
807809
}
808810

src/test/run-pass/auto-encode.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ fn test_ebml<'a, 'b, A:
3333
Decodable<EBReader::Decoder<'b>>
3434
>(a1: &A) {
3535
let mut wr = std::io::MemWriter::new();
36-
let mut ebml_w = EBWriter::Encoder(&mut wr);
36+
let mut ebml_w = EBwriter::Encoder::new(&mut wr);
3737
a1.encode(&mut ebml_w);
3838
let bytes = wr.get_ref();
3939

40-
let d: serialize::ebml::Doc<'a> = EBReader::Doc(bytes);
41-
let mut decoder: EBReader::Decoder<'a> = EBReader::Decoder(d);
40+
let d: serialize::ebml::Doc<'a> = EBDoc::new(bytes);
41+
let mut decoder: EBReader::Decoder<'a> = EBreader::Decoder::new(d);
4242
let a2: A = Decodable::decode(&mut decoder);
4343
assert!(*a1 == a2);
4444
}

src/test/run-pass/deriving-encodable-decodable.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ use std::io::MemWriter;
2222
use rand::{random, Rand};
2323
use serialize::{Encodable, Decodable};
2424
use serialize::ebml;
25+
use serialize::ebml::Doc;
2526
use serialize::ebml::writer::Encoder;
2627
use serialize::ebml::reader::Decoder;
2728

@@ -58,10 +59,10 @@ fn roundtrip<'a, T: Rand + Eq + Encodable<Encoder<'a>> +
5859
Decodable<Decoder<'a>>>() {
5960
let obj: T = random();
6061
let mut w = MemWriter::new();
61-
let mut e = Encoder(&mut w);
62+
let mut e = Encoder::new(&mut w);
6263
obj.encode(&mut e);
63-
let doc = ebml::reader::Doc(@w.get_ref());
64-
let mut dec = Decoder(doc);
64+
let doc = ebml::Doc::new(@w.get_ref());
65+
let mut dec = Decoder::new(doc);
6566
let obj2 = Decodable::decode(&mut dec);
6667
assert!(obj == obj2);
6768
}

src/test/run-pass/issue-11881.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ fn encode_ebml<'a,
4343
T: Encodable<writer::Encoder<'a, MemWriter>,
4444
std::io::IoError>>(val: &T,
4545
wr: &'a mut MemWriter) {
46-
let mut encoder = writer::Encoder(wr);
46+
let mut encoder = writer::Encoder::new(wr);
4747
val.encode(&mut encoder);
4848
}
4949

0 commit comments

Comments
 (0)