1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
// Copyright 2015-2017 Parity Technologies (UK) Ltd. // 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/>. //! Common RLP traits use ::{DecoderError, UntrustedRlp}; use bytes::VecLike; use rlpstream::RlpStream; use elastic_array::ElasticArray1024; /// Type is able to decode RLP. pub trait Decoder: Sized { /// Read a value from the RLP into a given type. fn read_value<T, F>(&self, f: &F) -> Result<T, DecoderError> where F: Fn(&[u8]) -> Result<T, DecoderError>; /// Get underlying `UntrustedRLP` object. fn as_rlp(&self) -> &UntrustedRlp; /// Get underlying raw bytes slice. fn as_raw(&self) -> &[u8]; } /// RLP decodable trait pub trait Decodable: Sized { /// Decode a value from RLP bytes fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder; } /// Internal helper trait. Implement `Decodable` for custom types. pub trait RlpDecodable: Sized { /// Decode a value from RLP bytes fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder; } /// A view into RLP encoded data pub trait View<'a, 'view>: Sized { /// RLP prototype type type Prototype; /// Payload info type type PayloadInfo; /// Data type type Data; /// Item type type Item; /// Iterator type type Iter; /// Creates a new instance of `Rlp` reader fn new(bytes: &'a [u8]) -> Self; /// The raw data of the RLP as slice. /// /// ```rust /// extern crate rlp; /// use rlp::*; /// /// fn main () { /// let data = vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g']; /// let rlp = Rlp::new(&data); /// let dog = rlp.at(1).as_raw(); /// assert_eq!(dog, &[0x83, b'd', b'o', b'g']); /// } /// ``` fn as_raw(&'view self) -> &'a [u8]; /// Get the prototype of the RLP. fn prototype(&self) -> Self::Prototype; /// Get payload info. fn payload_info(&self) -> Self::PayloadInfo; /// Get underlieing data. fn data(&'view self) -> Self::Data; /// Returns number of RLP items. /// /// ```rust /// extern crate rlp; /// use rlp::*; /// /// fn main () { /// let data = vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g']; /// let rlp = Rlp::new(&data); /// assert_eq!(rlp.item_count(), 2); /// let view = rlp.at(1); /// assert_eq!(view.item_count(), 0); /// } /// ``` fn item_count(&self) -> usize; /// Returns the number of bytes in the data, or zero if it isn't data. /// /// ```rust /// extern crate rlp; /// use rlp::*; /// /// fn main () { /// let data = vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g']; /// let rlp = Rlp::new(&data); /// assert_eq!(rlp.size(), 0); /// let view = rlp.at(1); /// assert_eq!(view.size(), 3); /// } /// ``` fn size(&self) -> usize; /// Get view onto RLP-slice at index. /// /// Caches offset to given index, so access to successive /// slices is faster. /// /// ```rust /// extern crate rlp; /// use rlp::*; /// /// fn main () { /// let data = vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g']; /// let rlp = Rlp::new(&data); /// let dog: String = rlp.at(1).as_val(); /// assert_eq!(dog, "dog".to_string()); /// } fn at(&'view self, index: usize) -> Self::Item; /// No value /// /// ```rust /// extern crate rlp; /// use rlp::*; /// /// fn main () { /// let data = vec![]; /// let rlp = Rlp::new(&data); /// assert!(rlp.is_null()); /// } /// ``` fn is_null(&self) -> bool; /// Contains a zero-length string or zero-length list. /// /// ```rust /// extern crate rlp; /// use rlp::*; /// /// fn main () { /// let data = vec![0xc0]; /// let rlp = Rlp::new(&data); /// assert!(rlp.is_empty()); /// } /// ``` fn is_empty(&self) -> bool; /// List value /// /// ```rust /// extern crate rlp; /// use rlp::*; /// /// fn main () { /// let data = vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g']; /// let rlp = Rlp::new(&data); /// assert!(rlp.is_list()); /// } /// ``` fn is_list(&self) -> bool; /// String value /// /// ```rust /// extern crate rlp; /// use rlp::*; /// /// fn main () { /// let data = vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g']; /// let rlp = Rlp::new(&data); /// assert!(rlp.at(1).is_data()); /// } /// ``` fn is_data(&self) -> bool; /// Int value /// /// ```rust /// extern crate rlp; /// use rlp::*; /// /// fn main () { /// let data = vec![0xc1, 0x10]; /// let rlp = Rlp::new(&data); /// assert_eq!(rlp.is_int(), false); /// assert_eq!(rlp.at(0).is_int(), true); /// } /// ``` fn is_int(&self) -> bool; /// Get iterator over rlp-slices /// /// ```rust /// extern crate rlp; /// use rlp::*; /// /// fn main () { /// let data = vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g']; /// let rlp = Rlp::new(&data); /// let strings: Vec<String> = rlp.iter().map(| i | i.as_val()).collect(); /// } /// ``` fn iter(&'view self) -> Self::Iter; /// Decode data into an object fn as_val<T>(&self) -> Result<T, DecoderError> where T: RlpDecodable; /// Decode data at given list index into an object fn val_at<T>(&self, index: usize) -> Result<T, DecoderError> where T: RlpDecodable; } /// Raw RLP encoder pub trait Encoder { /// Write a value represented as bytes fn emit_value<E: ByteEncodable>(&mut self, value: &E); /// Write raw preencoded data to the output fn emit_raw(&mut self, bytes: &[u8]) -> (); } /// Primitive data type encodable to RLP pub trait ByteEncodable { /// Serialize this object to given byte container fn to_bytes<V: VecLike<u8>>(&self, out: &mut V); /// Get size of serialised data in bytes fn bytes_len(&self) -> usize; } /// Structure encodable to RLP. Implement this trait for pub trait Encodable { /// Append a value to the stream fn rlp_append(&self, s: &mut RlpStream); /// Get rlp-encoded bytes for this instance fn rlp_bytes(&self) -> ElasticArray1024<u8> { let mut s = RlpStream::new(); self.rlp_append(&mut s); s.drain() } } /// Encodable wrapper trait required to handle special case of encoding a &[u8] as string and not as list pub trait RlpEncodable { /// Append a value to the stream fn rlp_append(&self, s: &mut RlpStream); } /// RLP encoding stream pub trait Stream: Sized { /// Initializes instance of empty `Stream`. fn new() -> Self; /// Initializes the `Stream` as a list. fn new_list(len: usize) -> Self; /// Apends value to the end of stream, chainable. /// /// ```rust /// 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<'a, E>(&'a mut self, value: &E) -> &'a mut Self where E: RlpEncodable; /// Declare appending the list of given size, chainable. /// /// ```rust /// 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_list(&mut self, len: usize) -> &mut Self; /// Apends null to the end of stream, chainable. /// /// ```rust /// 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_empty_data(&mut self) -> &mut Self; /// Appends raw (pre-serialised) RLP data. Use with caution. Chainable. fn append_raw<'a>(&'a mut self, bytes: &[u8], item_count: usize) -> &'a mut Self; /// Clear the output stream so far. /// /// ```rust /// 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 clear(&mut self); /// Returns true if stream doesnt expect any more items. /// /// ```rust /// 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 is_finished(&self) -> bool; /// Get raw encoded bytes fn as_raw(&self) -> &[u8]; /// Streams out encoded bytes. /// /// panic! if stream is not finished. fn out(self) -> Vec<u8>; } /// Trait for compressing and decompressing RLP by replacement of common terms. pub trait Compressible: Sized { /// Indicates the origin of RLP to be compressed. type DataType; /// Compress given RLP type using appropriate methods. fn compress(&self, t: Self::DataType) -> ElasticArray1024<u8>; /// Decompress given RLP type using appropriate methods. fn decompress(&self, t: Self::DataType) -> ElasticArray1024<u8>; }