      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

    use cmp;
    use io::{self, SeekFrom, Read, Initializer, Write, Seek, BufRead, Error, ErrorKind};
    use fmt;
    use mem;

    // =============================================================================
    // Forwarding implementations

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<'a, R: Read + ?Sized> Read for &'a mut R {
        #[inline]
        fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
            (**self).read(buf)
        }

        #[inline]
        unsafe fn initializer(&self) -> Initializer {
            (**self).initializer()
        }

        #[inline]
        fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
            (**self).read_to_end(buf)
        }

        #[inline]
        fn read_to_string(&mut self, buf: &mut String) -> io::Result<usize> {
            (**self).read_to_string(buf)
        }

        #[inline]
        fn read_exact(&mut self, buf: &mut [u8]) -> io::Result<()> {
            (**self).read_exact(buf)
        }
    }
    #[stable(feature = "rust1", since = "1.0.0")]
    impl<'a, W: Write + ?Sized> Write for &'a mut W {
        #[inline]
        fn write(&mut self, buf: &[u8]) -> io::Result<usize> { (**self).write(buf) }

        #[inline]
        fn flush(&mut self) -> io::Result<()> { (**self).flush() }

        #[inline]
        fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
            (**self).write_all(buf)
        }

        #[inline]
        fn write_fmt(&mut self, fmt: fmt::Arguments) -> io::Result<()> {
            (**self).write_fmt(fmt)
        }
    }
    #[stable(feature = "rust1", since = "1.0.0")]
    impl<'a, S: Seek + ?Sized> Seek for &'a mut S {
        #[inline]
        fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> { (**self).seek(pos) }
    }
    #[stable(feature = "rust1", since = "1.0.0")]
    impl<'a, B: BufRead + ?Sized> BufRead for &'a mut B {
        #[inline]
        fn fill_buf(&mut self) -> io::Result<&[u8]> { (**self).fill_buf() }

        #[inline]
        fn consume(&mut self, amt: usize) { (**self).consume(amt) }

        #[inline]
        fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> io::Result<usize> {
            (**self).read_until(byte, buf)
        }

        #[inline]
        fn read_line(&mut self, buf: &mut String) -> io::Result<usize> {
            (**self).read_line(buf)
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<R: Read + ?Sized> Read for Box<R> {
        #[inline]
        fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
            (**self).read(buf)
        }

        #[inline]
        unsafe fn initializer(&self) -> Initializer {
            (**self).initializer()
        }

        #[inline]
        fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
            (**self).read_to_end(buf)
        }

        #[inline]
        fn read_to_string(&mut self, buf: &mut String) -> io::Result<usize> {
            (**self).read_to_string(buf)
        }

        #[inline]
        fn read_exact(&mut self, buf: &mut [u8]) -> io::Result<()> {
            (**self).read_exact(buf)
        }
    }
    #[stable(feature = "rust1", since = "1.0.0")]
    impl<W: Write + ?Sized> Write for Box<W> {
        #[inline]
        fn write(&mut self, buf: &[u8]) -> io::Result<usize> { (**self).write(buf) }

        #[inline]
        fn flush(&mut self) -> io::Result<()> { (**self).flush() }

        #[inline]
        fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
            (**self).write_all(buf)
        }

        #[inline]
        fn write_fmt(&mut self, fmt: fmt::Arguments) -> io::Result<()> {
            (**self).write_fmt(fmt)
        }
    }
    #[stable(feature = "rust1", since = "1.0.0")]
    impl<S: Seek + ?Sized> Seek for Box<S> {
        #[inline]
        fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> { (**self).seek(pos) }
    }
    #[stable(feature = "rust1", since = "1.0.0")]
    impl<B: BufRead + ?Sized> BufRead for Box<B> {
        #[inline]
        fn fill_buf(&mut self) -> io::Result<&[u8]> { (**self).fill_buf() }

        #[inline]
        fn consume(&mut self, amt: usize) { (**self).consume(amt) }

        #[inline]
        fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> io::Result<usize> {
            (**self).read_until(byte, buf)
        }

        #[inline]
        fn read_line(&mut self, buf: &mut String) -> io::Result<usize> {
            (**self).read_line(buf)
        }
    }

    // =============================================================================
    // In-memory buffer implementations

    /// Read is implemented for `&[u8]` by copying from the slice.
    ///
    /// Note that reading updates the slice to point to the yet unread part.
    /// The slice will be empty when EOF is reached.
    #[stable(feature = "rust1", since = "1.0.0")]
    impl<'a> Read for &'a [u8] {
        #[inline]
        fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
            let amt = cmp::min(buf.len(), self.len());
            let (a, b) = self.split_at(amt);

            // First check if the amount of bytes we want to read is small:
            // `copy_from_slice` will generally expand to a call to `memcpy`, and
            // for a single byte the overhead is significant.
            if amt == 1 {
                buf[0] = a[0];
            } else {
                buf[..amt].copy_from_slice(a);
            }

            *self = b;
            Ok(amt)
        }

        #[inline]
        unsafe fn initializer(&self) -> Initializer {
            Initializer::nop()
        }

        #[inline]
        fn read_exact(&mut self, buf: &mut [u8]) -> io::Result<()> {
            if buf.len() > self.len() {
                return Err(Error::new(ErrorKind::UnexpectedEof,
                                      "failed to fill whole buffer"));
            }
            let (a, b) = self.split_at(buf.len());

            // First check if the amount of bytes we want to read is small:
            // `copy_from_slice` will generally expand to a call to `memcpy`, and
            // for a single byte the overhead is significant.
            if buf.len() == 1 {
                buf[0] = a[0];
            } else {
                buf.copy_from_slice(a);
            }

            *self = b;
            Ok(())
        }

        #[inline]
        fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
            buf.extend_from_slice(*self);
            let len = self.len();
            *self = &self[len..];
            Ok(len)
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<'a> BufRead for &'a [u8] {
        #[inline]
        fn fill_buf(&mut self) -> io::Result<&[u8]> { Ok(*self) }

        #[inline]
        fn consume(&mut self, amt: usize) { *self = &self[amt..]; }
    }

    /// Write is implemented for `&mut [u8]` by copying into the slice, overwriting
    /// its data.
    ///
    /// Note that writing updates the slice to point to the yet unwritten part.
    /// The slice will be empty when it has been completely overwritten.
    #[stable(feature = "rust1", since = "1.0.0")]
    impl<'a> Write for &'a mut [u8] {
        #[inline]
        fn write(&mut self, data: &[u8]) -> io::Result<usize> {
            let amt = cmp::min(data.len(), self.len());
            let (a, b) = mem::replace(self, &mut []).split_at_mut(amt);
            a.copy_from_slice(&data[..amt]);
            *self = b;
            Ok(amt)
        }

        #[inline]
        fn write_all(&mut self, data: &[u8]) -> io::Result<()> {
            if self.write(data)? == data.len() {
                Ok(())
            } else {
                Err(Error::new(ErrorKind::WriteZero, "failed to write whole buffer"))
            }
        }

        #[inline]
        fn flush(&mut self) -> io::Result<()> { Ok(()) }
    }

    /// Write is implemented for `Vec<u8>` by appending to the vector.
    /// The vector will grow as needed.
    #[stable(feature = "rust1", since = "1.0.0")]
    impl Write for Vec<u8> {
        #[inline]
        fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
            self.extend_from_slice(buf);
            Ok(buf.len())
        }

        #[inline]
        fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
            self.extend_from_slice(buf);
            Ok(())
        }

        #[inline]
        fn flush(&mut self) -> io::Result<()> { Ok(()) }
    }

    #[cfg(test)]
    mod tests {
        use io::prelude::*;
        use test;

        #[bench]
        fn bench_read_slice(b: &mut test::Bencher) {
            let buf = [5; 1024];
            let mut dst = [0; 128];

            b.iter(|| {
                let mut rd = &buf[..];
                for _ in 0..8 {
                    let _ = rd.read(&mut dst);
                    test::black_box(&dst);
                }
            })
        }

        #[bench]
        fn bench_write_slice(b: &mut test::Bencher) {
            let mut buf = [0; 1024];
            let src = [5; 128];

            b.iter(|| {
                let mut wr = &mut buf[..];
                for _ in 0..8 {
                    let _ = wr.write_all(&src);
                    test::black_box(&wr);
                }
            })
        }

        #[bench]
        fn bench_read_vec(b: &mut test::Bencher) {
            let buf = vec![5; 1024];
            let mut dst = [0; 128];

            b.iter(|| {
                let mut rd = &buf[..];
                for _ in 0..8 {
                    let _ = rd.read(&mut dst);
                    test::black_box(&dst);
                }
            })
        }

        #[bench]
        fn bench_write_vec(b: &mut test::Bencher) {
            let mut buf = Vec::with_capacity(1024);
            let src = [5; 128];

            b.iter(|| {
                let mut wr = &mut buf[..];
                for _ in 0..8 {
                    let _ = wr.write_all(&src);
                    test::black_box(&wr);
                }
            })
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)