Struct rlp::RlpStream

pub struct RlpStream { /* fields omitted */ }

Appendable rlp encoder.

Methods

impl RlpStream

fn new() -> Self

Initializes instance of empty Stream.

fn new_list(len: usize) -> Self

Initializes the Stream as a list.

fn append<'a, E>(&'a mut self, value: &E) -> &'a mut Self where
    E: Encodable, 

Appends value to the end of stream, chainable.

extern crate rlp;
use rlp::*;

fn main () {
    let mut stream = RlpStream::new_list(2);
    stream.append(&"cat").append(&"dog");
    let out = stream.out();
    assert_eq!(out, vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g']);
}

fn append_list<'a, E, K>(&'a mut self, values: &[K]) -> &'a mut Self where
    E: Encodable,
    K: Borrow<E>, 

Appends list of values to the end of stream, chainable.

fn append_internal<'a, E>(&'a mut self, value: &E) -> &'a mut Self where
    E: Encodable, 

Appends value to the end of stream, but do not count it as an appended item. It's useful for wrapper types

fn begin_list(&mut self, len: usize) -> &mut RlpStream

Declare appending the list of given size, chainable.

extern crate rlp;
use rlp::*;

fn main () {
    let mut stream = RlpStream::new_list(2);
    stream.begin_list(2).append(&"cat").append(&"dog");
    stream.append(&"");
    let out = stream.out();
    assert_eq!(out, vec![0xca, 0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g', 0x80]);
}

fn begin_unbounded_list(&mut self) -> &mut RlpStream

Declare appending the list of unknown size, chainable.

fn append_empty_data(&mut self) -> &mut RlpStream

Apends null to the end of stream, chainable.

extern crate rlp;
use rlp::*;

fn main () {
    let mut stream = RlpStream::new_list(2);
    stream.append_empty_data().append_empty_data();
    let out = stream.out();
    assert_eq!(out, vec![0xc2, 0x80, 0x80]);
}

fn append_raw<'a>(
    &'a mut self,
    bytes: &[u8],
    item_count: usize
) -> &'a mut RlpStream

Appends raw (pre-serialised) RLP data. Use with caution. Chainable.

fn append_raw_checked<'a>(
    &'a mut self,
    bytes: &[u8],
    item_count: usize,
    max_size: usize
) -> bool

Appends raw (pre-serialised) RLP data. Checks for size oveflow.

fn estimate_size<'a>(&'a self, add: usize) -> usize

Calculate total RLP size for appended payload.

fn len<'a>(&'a self) -> usize

Returns current RLP size in bytes for the data pushed into the list.

fn clear(&mut self)

Clear the output stream so far.

extern crate rlp;
use rlp::*;

fn main () {
    let mut stream = RlpStream::new_list(3);
    stream.append(&"cat");
    stream.clear();
    stream.append(&"dog");
    let out = stream.out();
    assert_eq!(out, vec![0x83, b'd', b'o', b'g']);
}

fn is_finished(&self) -> bool

Returns true if stream doesnt expect any more items.

extern crate rlp;
use rlp::*;

fn main () {
    let mut stream = RlpStream::new_list(2);
    stream.append(&"cat");
    assert_eq!(stream.is_finished(), false);
    stream.append(&"dog");
    assert_eq!(stream.is_finished(), true);
    let out = stream.out();
    assert_eq!(out, vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g']);
}

fn as_raw(&self) -> &[u8]

Get raw encoded bytes

fn out(self) -> Vec<u8>

Streams out encoded bytes.

panic! if stream is not finished.

fn encoder(&mut self) -> BasicEncoder

fn drain(self) -> ElasticArray1024<u8>

Drain the object and return the underlying ElasticArray.

fn complete_unbounded_list(&mut self)

Finalize current ubnbound list. Panics if no unbounded list has been opened.

Trait Implementations

impl Default for RlpStream

fn default() -> Self

Returns the "default value" for a type.