openethereum/util/rlp/src/lib.rs

124 lines
3.5 KiB
Rust
Raw Normal View History

// Copyright 2015-2017 Parity Technologies (UK) Ltd.
2016-02-05 13:40:41 +01:00
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
//! Recursive Length Prefix serialization crate.
2015-12-26 15:48:41 +01:00
//!
//! Allows encoding, decoding, and view onto rlp-slice
2015-12-08 00:07:07 +01:00
//!
//!# What should you use when?
//!
2015-12-26 15:48:41 +01:00
//!### Use `encode` function when:
2015-12-08 00:07:07 +01:00
//! * You want to encode something inline.
//! * You do not work on big set of data.
//! * You want to encode whole data structure at once.
//!
//!### Use `decode` function when:
//! * You want to decode something inline.
//! * You do not work on big set of data.
//! * You want to decode whole rlp at once.
//!
//!### Use `RlpStream` when:
//! * You want to encode something in portions.
//! * You encode a big set of data.
//!
//!### Use `Rlp` when:
//! * You are working on trusted data (not corrupted).
//! * You want to get view onto rlp-slice.
//! * You don't want to decode whole rlp at once.
//!
2015-12-26 15:48:41 +01:00
//!### Use `UntrustedRlp` when:
2015-12-08 00:07:07 +01:00
//! * You are working on untrusted data (~corrupted).
//! * You need to handle data corruption errors.
//! * You are working on input data.
//! * You want to get view onto rlp-slice.
//! * You don't want to decode whole rlp at once.
extern crate byteorder;
2016-09-13 15:26:31 +02:00
extern crate ethcore_bigint as bigint;
extern crate elastic_array;
extern crate rustc_serialize;
#[macro_use]
extern crate lazy_static;
mod traits;
mod error;
mod rlpin;
mod untrusted_rlp;
mod stream;
mod compression;
mod common;
mod impls;
use std::borrow::Borrow;
use elastic_array::ElasticArray1024;
pub use error::DecoderError;
pub use traits::{Decodable, Encodable, Compressible};
pub use untrusted_rlp::{UntrustedRlp, UntrustedRlpIterator, PayloadInfo, Prototype};
pub use rlpin::{Rlp, RlpIterator};
pub use stream::RlpStream;
pub use compression::RlpType;
/// The RLP encoded empty data (used to mean "null value").
pub const NULL_RLP: [u8; 1] = [0x80; 1];
/// The RLP encoded empty list.
2015-12-26 15:48:41 +01:00
pub const EMPTY_LIST_RLP: [u8; 1] = [0xC0; 1];
2015-12-08 00:45:04 +01:00
/// Shortcut function to decode trusted rlp
2015-12-26 15:48:41 +01:00
///
/// ```rust
/// extern crate rlp;
2015-12-26 15:48:41 +01:00
///
/// fn main () {
/// let data = vec![0x83, b'c', b'a', b't'];
/// let animal: String = rlp::decode(&data);
/// assert_eq!(animal, "cat".to_owned());
/// }
/// ```
pub fn decode<T>(bytes: &[u8]) -> T where T: Decodable {
2015-12-08 00:45:04 +01:00
let rlp = Rlp::new(bytes);
rlp.as_val()
}
pub fn decode_list<T>(bytes: &[u8]) -> Vec<T> where T: Decodable {
let rlp = Rlp::new(bytes);
rlp.as_list()
}
/// Shortcut function to encode structure into rlp.
///
/// ```rust
/// extern crate rlp;
2015-12-26 15:48:41 +01:00
///
/// fn main () {
2016-01-27 12:14:57 +01:00
/// let animal = "cat";
/// let out = rlp::encode(&animal).to_vec();
2016-01-27 12:14:57 +01:00
/// assert_eq!(out, vec![0x83, b'c', b'a', b't']);
/// }
/// ```
pub fn encode<E>(object: &E) -> ElasticArray1024<u8> where E: Encodable {
2016-01-27 12:14:57 +01:00
let mut stream = RlpStream::new();
stream.append(object);
stream.drain()
}
pub fn encode_list<E, K>(object: &[K]) -> ElasticArray1024<u8> where E: Encodable, K: Borrow<E> {
let mut stream = RlpStream::new();
stream.append_list(object);
stream.drain()
}