src/libserialize/opaque.rs

   1 use crate::leb128::{self, read_signed_leb128, write_signed_leb128};
   2 use std::borrow::Cow;
   3 use crate::serialize;
   4
   5 // -----------------------------------------------------------------------------
   6 // Encoder
   7 // -----------------------------------------------------------------------------
   8
   9 pub type EncodeResult = Result<(), !>;
  10
  11 pub struct Encoder {
  12     pub data: Vec<u8>,
  13 }
  14
  15 impl Encoder {
  16     pub fn new(data: Vec<u8>) -> Encoder {
  17         Encoder { data }
  18     }
  19
  20     pub fn into_inner(self) -> Vec<u8> {
  21         self.data
  22     }
  23
  24     #[inline]
  25     pub fn emit_raw_bytes(&mut self, s: &[u8]) {
  26         self.data.extend_from_slice(s);
  27     }
  28 }
  29
  30 macro_rules! write_uleb128 {
  31     ($enc:expr, $value:expr, $fun:ident) => {{
  32         leb128::$fun(&mut $enc.data, $value);
  33         Ok(())
  34     }}
  35 }
  36
  37 macro_rules! write_sleb128 {
  38     ($enc:expr, $value:expr) => {{
  39         write_signed_leb128(&mut $enc.data, $value as i128);
  40         Ok(())
  41     }}
  42 }
  43
  44 impl serialize::Encoder for Encoder {
  45     type Error = !;
  46
  47     #[inline]
  48     fn emit_unit(&mut self) -> EncodeResult {
  49         Ok(())
  50     }
  51
  52     #[inline]
  53     fn emit_usize(&mut self, v: usize) -> EncodeResult {
  54         write_uleb128!(self, v, write_usize_leb128)
  55     }
  56
  57     #[inline]
  58     fn emit_u128(&mut self, v: u128) -> EncodeResult {
  59         write_uleb128!(self, v, write_u128_leb128)
  60     }
  61
  62     #[inline]
  63     fn emit_u64(&mut self, v: u64) -> EncodeResult {
  64         write_uleb128!(self, v, write_u64_leb128)
  65     }
  66
  67     #[inline]
  68     fn emit_u32(&mut self, v: u32) -> EncodeResult {
  69         write_uleb128!(self, v, write_u32_leb128)
  70     }
  71
  72     #[inline]
  73     fn emit_u16(&mut self, v: u16) -> EncodeResult {
  74         write_uleb128!(self, v, write_u16_leb128)
  75     }
  76
  77     #[inline]
  78     fn emit_u8(&mut self, v: u8) -> EncodeResult {
  79         self.data.push(v);
  80         Ok(())
  81     }
  82
  83     #[inline]
  84     fn emit_isize(&mut self, v: isize) -> EncodeResult {
  85         write_sleb128!(self, v)
  86     }
  87
  88     #[inline]
  89     fn emit_i128(&mut self, v: i128) -> EncodeResult {
  90         write_sleb128!(self, v)
  91     }
  92
  93     #[inline]
  94     fn emit_i64(&mut self, v: i64) -> EncodeResult {
  95         write_sleb128!(self, v)
  96     }
  97
  98     #[inline]
  99     fn emit_i32(&mut self, v: i32) -> EncodeResult {
 100         write_sleb128!(self, v)
 101     }
 102
 103     #[inline]
 104     fn emit_i16(&mut self, v: i16) -> EncodeResult {
 105         write_sleb128!(self, v)
 106     }
 107
 108     #[inline]
 109     fn emit_i8(&mut self, v: i8) -> EncodeResult {
 110         let as_u8: u8 = unsafe { ::std::mem::transmute(v) };
 111         self.emit_u8(as_u8)
 112     }
 113
 114     #[inline]
 115     fn emit_bool(&mut self, v: bool) -> EncodeResult {
 116         self.emit_u8(if v {
 117             1
 118         } else {
 119             0
 120         })
 121     }
 122
 123     #[inline]
 124     fn emit_f64(&mut self, v: f64) -> EncodeResult {
 125         let as_u64: u64 = unsafe { ::std::mem::transmute(v) };
 126         self.emit_u64(as_u64)
 127     }
 128
 129     #[inline]
 130     fn emit_f32(&mut self, v: f32) -> EncodeResult {
 131         let as_u32: u32 = unsafe { ::std::mem::transmute(v) };
 132         self.emit_u32(as_u32)
 133     }
 134
 135     #[inline]
 136     fn emit_char(&mut self, v: char) -> EncodeResult {
 137         self.emit_u32(v as u32)
 138     }
 139
 140     #[inline]
 141     fn emit_str(&mut self, v: &str) -> EncodeResult {
 142         self.emit_usize(v.len())?;
 143         self.emit_raw_bytes(v.as_bytes());
 144         Ok(())
 145     }
 146 }
 147
 148 impl Encoder {
 149     #[inline]
 150     pub fn position(&self) -> usize {
 151         self.data.len()
 152     }
 153 }
 154
 155 // -----------------------------------------------------------------------------
 156 // Decoder
 157 // -----------------------------------------------------------------------------
 158
 159 pub struct Decoder<'a> {
 160     pub data: &'a [u8],
 161     position: usize,
 162 }
 163
 164 impl<'a> Decoder<'a> {
 165     #[inline]
 166     pub fn new(data: &'a [u8], position: usize) -> Decoder<'a> {
 167         Decoder {
 168             data,
 169             position,
 170         }
 171     }
 172
 173     #[inline]
 174     pub fn position(&self) -> usize {
 175         self.position
 176     }
 177
 178     #[inline]
 179     pub fn set_position(&mut self, pos: usize) {
 180         self.position = pos
 181     }
 182
 183     #[inline]
 184     pub fn advance(&mut self, bytes: usize) {
 185         self.position += bytes;
 186     }
 187
 188     #[inline]
 189     pub fn read_raw_bytes(&mut self, s: &mut [u8]) -> Result<(), String> {
 190         let start = self.position;
 191         let end = start + s.len();
 192
 193         s.copy_from_slice(&self.data[start..end]);
 194
 195         self.position = end;
 196
 197         Ok(())
 198     }
 199 }
 200
 201 macro_rules! read_uleb128 {
 202     ($dec:expr, $t:ty, $fun:ident) => ({
 203         let (value, bytes_read) = leb128::$fun(&$dec.data[$dec.position ..]);
 204         $dec.position += bytes_read;
 205         Ok(value)
 206     })
 207 }
 208
 209 macro_rules! read_sleb128 {
 210     ($dec:expr, $t:ty) => ({
 211         let (value, bytes_read) = read_signed_leb128($dec.data, $dec.position);
 212         $dec.position += bytes_read;
 213         Ok(value as $t)
 214     })
 215 }
 216
 217
 218 impl<'a> serialize::Decoder for Decoder<'a> {
 219     type Error = String;
 220
 221     #[inline]
 222     fn read_nil(&mut self) -> Result<(), Self::Error> {
 223         Ok(())
 224     }
 225
 226     #[inline]
 227     fn read_u128(&mut self) -> Result<u128, Self::Error> {
 228         read_uleb128!(self, u128, read_u128_leb128)
 229     }
 230
 231     #[inline]
 232     fn read_u64(&mut self) -> Result<u64, Self::Error> {
 233         read_uleb128!(self, u64, read_u64_leb128)
 234     }
 235
 236     #[inline]
 237     fn read_u32(&mut self) -> Result<u32, Self::Error> {
 238         read_uleb128!(self, u32, read_u32_leb128)
 239     }
 240
 241     #[inline]
 242     fn read_u16(&mut self) -> Result<u16, Self::Error> {
 243         read_uleb128!(self, u16, read_u16_leb128)
 244     }
 245
 246     #[inline]
 247     fn read_u8(&mut self) -> Result<u8, Self::Error> {
 248         let value = self.data[self.position];
 249         self.position += 1;
 250         Ok(value)
 251     }
 252
 253     #[inline]
 254     fn read_usize(&mut self) -> Result<usize, Self::Error> {
 255         read_uleb128!(self, usize, read_usize_leb128)
 256     }
 257
 258     #[inline]
 259     fn read_i128(&mut self) -> Result<i128, Self::Error> {
 260         read_sleb128!(self, i128)
 261     }
 262
 263     #[inline]
 264     fn read_i64(&mut self) -> Result<i64, Self::Error> {
 265         read_sleb128!(self, i64)
 266     }
 267
 268     #[inline]
 269     fn read_i32(&mut self) -> Result<i32, Self::Error> {
 270         read_sleb128!(self, i32)
 271     }
 272
 273     #[inline]
 274     fn read_i16(&mut self) -> Result<i16, Self::Error> {
 275         read_sleb128!(self, i16)
 276     }
 277
 278     #[inline]
 279     fn read_i8(&mut self) -> Result<i8, Self::Error> {
 280         let as_u8 = self.data[self.position];
 281         self.position += 1;
 282         unsafe { Ok(::std::mem::transmute(as_u8)) }
 283     }
 284
 285     #[inline]
 286     fn read_isize(&mut self) -> Result<isize, Self::Error> {
 287         read_sleb128!(self, isize)
 288     }
 289
 290     #[inline]
 291     fn read_bool(&mut self) -> Result<bool, Self::Error> {
 292         let value = self.read_u8()?;
 293         Ok(value != 0)
 294     }
 295
 296     #[inline]
 297     fn read_f64(&mut self) -> Result<f64, Self::Error> {
 298         let bits = self.read_u64()?;
 299         Ok(unsafe { ::std::mem::transmute(bits) })
 300     }
 301
 302     #[inline]
 303     fn read_f32(&mut self) -> Result<f32, Self::Error> {
 304         let bits = self.read_u32()?;
 305         Ok(unsafe { ::std::mem::transmute(bits) })
 306     }
 307
 308     #[inline]
 309     fn read_char(&mut self) -> Result<char, Self::Error> {
 310         let bits = self.read_u32()?;
 311         Ok(::std::char::from_u32(bits).unwrap())
 312     }
 313
 314     #[inline]
 315     fn read_str(&mut self) -> Result<Cow<'_, str>, Self::Error> {
 316         let len = self.read_usize()?;
 317         let s = ::std::str::from_utf8(&self.data[self.position..self.position + len]).unwrap();
 318         self.position += len;
 319         Ok(Cow::Borrowed(s))
 320     }
 321
 322     #[inline]
 323     fn error(&mut self, err: &str) -> Self::Error {
 324         err.to_string()
 325     }
 326 }
 327
 328
 329 #[cfg(test)]
 330 mod tests {
 331     use crate::serialize::{Encodable, Decodable};
 332     use std::fmt::Debug;
 333     use super::{Encoder, Decoder};
 334
 335     #[derive(PartialEq, Clone, Debug, RustcEncodable, RustcDecodable)]
 336     struct Struct {
 337         a: (),
 338         b: u8,
 339         c: u16,
 340         d: u32,
 341         e: u64,
 342         f: usize,
 343
 344         g: i8,
 345         h: i16,
 346         i: i32,
 347         j: i64,
 348         k: isize,
 349
 350         l: char,
 351         m: String,
 352         n: f32,
 353         o: f64,
 354         p: bool,
 355         q: Option<u32>,
 356     }
 357
 358
 359     fn check_round_trip<T: Encodable + Decodable + PartialEq + Debug>(values: Vec<T>) {
 360         let mut encoder = Encoder::new(Vec::new());
 361
 362         for value in &values {
 363             Encodable::encode(&value, &mut encoder).unwrap();
 364         }
 365
 366         let data = encoder.into_inner();
 367         let mut decoder = Decoder::new(&data[..], 0);
 368
 369         for value in values {
 370             let decoded = Decodable::decode(&mut decoder).unwrap();
 371             assert_eq!(value, decoded);
 372         }
 373     }
 374
 375     #[test]
 376     fn test_unit() {
 377         check_round_trip(vec![(), (), (), ()]);
 378     }
 379
 380     #[test]
 381     fn test_u8() {
 382         let mut vec = vec![];
 383         for i in ::std::u8::MIN..::std::u8::MAX {
 384             vec.push(i);
 385         }
 386         check_round_trip(vec);
 387     }
 388
 389     #[test]
 390     fn test_u16() {
 391         for i in ::std::u16::MIN..::std::u16::MAX {
 392             check_round_trip(vec![1, 2, 3, i, i, i]);
 393         }
 394     }
 395
 396     #[test]
 397     fn test_u32() {
 398         check_round_trip(vec![1, 2, 3, ::std::u32::MIN, 0, 1, ::std::u32::MAX, 2, 1]);
 399     }
 400
 401     #[test]
 402     fn test_u64() {
 403         check_round_trip(vec![1, 2, 3, ::std::u64::MIN, 0, 1, ::std::u64::MAX, 2, 1]);
 404     }
 405
 406     #[test]
 407     fn test_usize() {
 408         check_round_trip(vec![1, 2, 3, ::std::usize::MIN, 0, 1, ::std::usize::MAX, 2, 1]);
 409     }
 410
 411     #[test]
 412     fn test_i8() {
 413         let mut vec = vec![];
 414         for i in ::std::i8::MIN..::std::i8::MAX {
 415             vec.push(i);
 416         }
 417         check_round_trip(vec);
 418     }
 419
 420     #[test]
 421     fn test_i16() {
 422         for i in ::std::i16::MIN..::std::i16::MAX {
 423             check_round_trip(vec![-1, 2, -3, i, i, i, 2]);
 424         }
 425     }
 426
 427     #[test]
 428     fn test_i32() {
 429         check_round_trip(vec![-1, 2, -3, ::std::i32::MIN, 0, 1, ::std::i32::MAX, 2, 1]);
 430     }
 431
 432     #[test]
 433     fn test_i64() {
 434         check_round_trip(vec![-1, 2, -3, ::std::i64::MIN, 0, 1, ::std::i64::MAX, 2, 1]);
 435     }
 436
 437     #[test]
 438     fn test_isize() {
 439         check_round_trip(vec![-1, 2, -3, ::std::isize::MIN, 0, 1, ::std::isize::MAX, 2, 1]);
 440     }
 441
 442     #[test]
 443     fn test_bool() {
 444         check_round_trip(vec![false, true, true, false, false]);
 445     }
 446
 447     #[test]
 448     fn test_f32() {
 449         let mut vec = vec![];
 450         for i in -100..100 {
 451             vec.push((i as f32) / 3.0);
 452         }
 453         check_round_trip(vec);
 454     }
 455
 456     #[test]
 457     fn test_f64() {
 458         let mut vec = vec![];
 459         for i in -100..100 {
 460             vec.push((i as f64) / 3.0);
 461         }
 462         check_round_trip(vec);
 463     }
 464
 465     #[test]
 466     fn test_char() {
 467         let vec = vec!['a', 'b', 'c', 'd', 'A', 'X', ' ', '#', 'Ö', 'Ä', 'µ', '€'];
 468         check_round_trip(vec);
 469     }
 470
 471     #[test]
 472     fn test_string() {
 473         let vec = vec!["abcbuÖeiovÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
 474                        "abcbuÖganeiovÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
 475                        "abcbuÖganeiovÄnameÜavmpßvmea€µsbpapmaebn".to_string(),
 476                        "abcbuÖganeiovÄnameÜavmpßvmeabpnvapeapmaebn".to_string(),
 477                        "abcbuÖganeiÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
 478                        "abcbuÖganeiovÄnameÜavmpßvmea€µsbpmaebn".to_string(),
 479                        "abcbuÖganeiovÄnameÜavmpßvmea€µnvapeapmaebn".to_string()];
 480
 481         check_round_trip(vec);
 482     }
 483
 484     #[test]
 485     fn test_option() {
 486         check_round_trip(vec![Some(-1i8)]);
 487         check_round_trip(vec![Some(-2i16)]);
 488         check_round_trip(vec![Some(-3i32)]);
 489         check_round_trip(vec![Some(-4i64)]);
 490         check_round_trip(vec![Some(-5isize)]);
 491
 492         let none_i8: Option<i8> = None;
 493         check_round_trip(vec![none_i8]);
 494
 495         let none_i16: Option<i16> = None;
 496         check_round_trip(vec![none_i16]);
 497
 498         let none_i32: Option<i32> = None;
 499         check_round_trip(vec![none_i32]);
 500
 501         let none_i64: Option<i64> = None;
 502         check_round_trip(vec![none_i64]);
 503
 504         let none_isize: Option<isize> = None;
 505         check_round_trip(vec![none_isize]);
 506     }
 507
 508     #[test]
 509     fn test_struct() {
 510         check_round_trip(vec![Struct {
 511                                   a: (),
 512                                   b: 10,
 513                                   c: 11,
 514                                   d: 12,
 515                                   e: 13,
 516                                   f: 14,
 517
 518                                   g: 15,
 519                                   h: 16,
 520                                   i: 17,
 521                                   j: 18,
 522                                   k: 19,
 523
 524                                   l: 'x',
 525                                   m: "abc".to_string(),
 526                                   n: 20.5,
 527                                   o: 21.5,
 528                                   p: false,
 529                                   q: None,
 530                               }]);
 531
 532         check_round_trip(vec![Struct {
 533                                   a: (),
 534                                   b: 101,
 535                                   c: 111,
 536                                   d: 121,
 537                                   e: 131,
 538                                   f: 141,
 539
 540                                   g: -15,
 541                                   h: -16,
 542                                   i: -17,
 543                                   j: -18,
 544                                   k: -19,
 545
 546                                   l: 'y',
 547                                   m: "def".to_string(),
 548                                   n: -20.5,
 549                                   o: -21.5,
 550                                   p: true,
 551                                   q: Some(1234567),
 552                               }]);
 553     }
 554
 555     #[derive(PartialEq, Clone, Debug, RustcEncodable, RustcDecodable)]
 556     enum Enum {
 557         Variant1,
 558         Variant2(usize, f32),
 559         Variant3 {
 560             a: i32,
 561             b: char,
 562             c: bool,
 563         },
 564     }
 565
 566     #[test]
 567     fn test_enum() {
 568         check_round_trip(vec![Enum::Variant1,
 569                               Enum::Variant2(1, 2.5),
 570                               Enum::Variant3 {
 571                                   a: 3,
 572                                   b: 'b',
 573                                   c: false,
 574                               },
 575                               Enum::Variant3 {
 576                                   a: -4,
 577                                   b: 'f',
 578                                   c: true,
 579                               }]);
 580     }
 581
 582     #[test]
 583     fn test_sequence() {
 584         let mut vec = vec![];
 585         for i in -100i64..100i64 {
 586             vec.push(i * 100000);
 587         }
 588
 589         check_round_trip(vec![vec]);
 590     }
 591
 592     #[test]
 593     fn test_hash_map() {
 594         use std::collections::HashMap;
 595         let mut map = HashMap::new();
 596         for i in -100i64..100i64 {
 597             map.insert(i * 100000, i * 10000);
 598         }
 599
 600         check_round_trip(vec![map]);
 601     }
 602
 603     #[test]
 604     fn test_tuples() {
 605         check_round_trip(vec![('x', (), false, 0.5f32)]);
 606         check_round_trip(vec![(9i8, 10u16, 1.5f64)]);
 607         check_round_trip(vec![(-12i16, 11u8, 12usize)]);
 608         check_round_trip(vec![(1234567isize, 100000000000000u64, 99999999999999i64)]);
 609         check_round_trip(vec![(String::new(), "some string".to_string())]);
 610     }
 611 }