milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Add docs for SimpleDecoder and SimpleEncoder traits

This commit is contained in:
Andrew Poelstra 2014-08-01 11:16:18 -07:00
parent c80ec9bda8
commit 275c93ab6b
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/network/serialize.rs
View File

@ -86,33 +86,52 @@ impl<R:Reader> RawDecoder<R> {
/// A simple Encoder trait /// A simple Encoder trait
pub trait SimpleEncoder<E> { pub trait SimpleEncoder<E> {
/// Output a 64-bit uint
fn emit_u64(&mut self, v: u64) -> Result<(), E>; fn emit_u64(&mut self, v: u64) -> Result<(), E>;
/// Output a 32-bit uint
fn emit_u32(&mut self, v: u32) -> Result<(), E>; fn emit_u32(&mut self, v: u32) -> Result<(), E>;
/// Output a 16-bit uint
fn emit_u16(&mut self, v: u16) -> Result<(), E>; fn emit_u16(&mut self, v: u16) -> Result<(), E>;
/// Output a 8-bit uint
fn emit_u8(&mut self, v: u8) -> Result<(), E>; fn emit_u8(&mut self, v: u8) -> Result<(), E>;
/// Output a 64-bit int
fn emit_i64(&mut self, v: i64) -> Result<(), E>; fn emit_i64(&mut self, v: i64) -> Result<(), E>;
/// Output a 32-bit int
fn emit_i32(&mut self, v: i32) -> Result<(), E>; fn emit_i32(&mut self, v: i32) -> Result<(), E>;
/// Output a 16-bit int
fn emit_i16(&mut self, v: i16) -> Result<(), E>; fn emit_i16(&mut self, v: i16) -> Result<(), E>;
/// Output a 8-bit int
fn emit_i8(&mut self, v: i8) -> Result<(), E>; fn emit_i8(&mut self, v: i8) -> Result<(), E>;
/// Output a boolean
fn emit_bool(&mut self, v: bool) -> Result<(), E>; fn emit_bool(&mut self, v: bool) -> Result<(), E>;
} }
/// A simple Decoder trait /// A simple Decoder trait
pub trait SimpleDecoder<E> { pub trait SimpleDecoder<E> {
/// Read a 64-bit uint
fn read_u64(&mut self) -> Result<u64, E>; fn read_u64(&mut self) -> Result<u64, E>;
/// Read a 32-bit uint
fn read_u32(&mut self) -> Result<u32, E>; fn read_u32(&mut self) -> Result<u32, E>;
/// Read a 16-bit uint
fn read_u16(&mut self) -> Result<u16, E>; fn read_u16(&mut self) -> Result<u16, E>;
/// Read a 8-bit uint
fn read_u8(&mut self) -> Result<u8, E>; fn read_u8(&mut self) -> Result<u8, E>;
/// Read a 64-bit int
fn read_i64(&mut self) -> Result<i64, E>; fn read_i64(&mut self) -> Result<i64, E>;
/// Read a 32-bit int
fn read_i32(&mut self) -> Result<i32, E>; fn read_i32(&mut self) -> Result<i32, E>;
/// Read a 16-bit int
fn read_i16(&mut self) -> Result<i16, E>; fn read_i16(&mut self) -> Result<i16, E>;
/// Read a 8-bit int
fn read_i8(&mut self) -> Result<i8, E>; fn read_i8(&mut self) -> Result<i8, E>;
/// Read a boolean
fn read_bool(&mut self) -> Result<bool, E>; fn read_bool(&mut self) -> Result<bool, E>;
/// Signal a decoding error
fn error(&mut self, err: &str) -> E; fn error(&mut self, err: &str) -> E;
} }