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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
use std::{
  future::Future,
  ops::DerefMut,
  pin::Pin,
  task::{Context, Poll},
};

use futures_util::AsyncRead;

use super::*;

mod peek;
pub use peek::Peek;
mod peek_exact;
pub use peek_exact::PeekExact;
mod peek_to_string;
pub use peek_to_string::PeekToString;
mod peek_to_end;
pub use peek_to_end::PeekToEnd;
mod peek_vectored;
pub use peek_vectored::PeekVectored;
mod fill_peek_buf;
pub use fill_peek_buf::FillPeekBuf;

/// Peek bytes asynchronously.
///
/// This trait is analogous to the `peekable::Peek` trait, but integrates
/// with the asynchronous task system. In particular, the `poll_read`
/// method, unlike `Peek::peek`, will automatically queue the current task
/// for wakeup and return if data is not yet available, rather than blocking
/// the calling thread.
pub trait AsyncPeek: AsyncRead {
  /// Attempt to peek from the `AsyncPeek` into `buf`.
  ///
  /// On success, returns `Poll::Ready(Ok(num_bytes_peek))`.
  ///
  /// If no data is available for reading, the method returns
  /// `Poll::Pending` and arranges for the current task (via
  /// `cx.waker().wake_by_ref()`) to receive a notification when the object becomes
  /// readable or is closed.
  ///
  /// # Implementation
  ///
  /// This function may not return errors of kind `WouldBlock` or
  /// `Interrupted`.  Implementations must convert `WouldBlock` into
  /// `Poll::Pending` and either internally retry or convert
  /// `Interrupted` into another error kind.
  fn poll_peek(self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8]) -> Poll<Result<usize>>;

  /// Attempt to read from the `AsyncPeek` into `bufs` using vectored
  /// IO operations.
  ///
  /// This method is similar to `poll_peek`, but allows data to be read
  /// into multiple buffers using a single operation.
  ///
  /// On success, returns `Poll::Ready(Ok(num_bytes_read))`.
  ///
  /// If no data is available for reading, the method returns
  /// `Poll::Pending` and arranges for the current task (via
  /// `cx.waker().wake_by_ref()`) to receive a notification when the object becomes
  /// readable or is closed.
  /// By default, this method delegates to using `poll_read` on the first
  /// nonempty buffer in `bufs`, or an empty one if none exists. Objects which
  /// support vectored IO should override this method.
  ///
  /// # Implementation
  ///
  /// This function may not return errors of kind `WouldBlock` or
  /// `Interrupted`.  Implementations must convert `WouldBlock` into
  /// `Poll::Pending` and either internally retry or convert
  /// `Interrupted` into another error kind.
  fn poll_peek_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>],
  ) -> Poll<Result<usize>> {
    for b in bufs {
      if !b.is_empty() {
        return self.poll_peek(cx, b);
      }
    }

    self.poll_peek(cx, &mut [])
  }
}

macro_rules! deref_async_peek {
  () => {
    fn poll_peek(
      mut self: Pin<&mut Self>,
      cx: &mut Context<'_>,
      buf: &mut [u8],
    ) -> Poll<Result<usize>> {
      Pin::new(&mut **self).poll_peek(cx, buf)
    }

    fn poll_peek_vectored(
      mut self: Pin<&mut Self>,
      cx: &mut Context<'_>,
      bufs: &mut [IoSliceMut<'_>],
    ) -> Poll<Result<usize>> {
      Pin::new(&mut **self).poll_peek_vectored(cx, bufs)
    }
  };
}

impl<T: ?Sized + AsyncPeek + Unpin> AsyncPeek for Box<T> {
  deref_async_peek!();
}

impl<T: ?Sized + AsyncPeek + Unpin> AsyncPeek for &mut T {
  deref_async_peek!();
}

impl<P> AsyncPeek for Pin<P>
where
  P: DerefMut + Unpin,
  P::Target: AsyncPeek,
{
  fn poll_peek(self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8]) -> Poll<Result<usize>> {
    self.get_mut().as_mut().poll_peek(cx, buf)
  }

  fn poll_peek_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>],
  ) -> Poll<Result<usize>> {
    self.get_mut().as_mut().poll_peek_vectored(cx, bufs)
  }
}

pin_project_lite::pin_project! {
  /// A wrapper around an [`AsyncRead`] types to make them support [`AsyncPeek`] methods.
  #[derive(Debug)]
  pub struct AsyncPeekable<R> {
    #[pin]
    reader: R,
    buffer: Buffer,
  }
}

impl<R> From<R> for AsyncPeekable<R> {
  fn from(reader: R) -> Self {
    Self {
      reader,
      buffer: Buffer::new(),
    }
  }
}

impl<R: AsyncRead> AsyncRead for AsyncPeekable<R> {
  fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    mut buf: &mut [u8],
  ) -> Poll<Result<usize>> {
    let want_read = buf.len();

    // check if the peek buffer has data
    let buffer_len = self.buffer.len();

    let this = self.project();
    if buffer_len > 0 {
      return match want_read.cmp(&buffer_len) {
        cmp::Ordering::Less => {
          buf.copy_from_slice(&this.buffer[..want_read]);
          this.buffer.drain(..want_read);
          return Poll::Ready(Ok(want_read));
        }
        cmp::Ordering::Equal => {
          buf.copy_from_slice(this.buffer);
          this.buffer.clear();
          return Poll::Ready(Ok(want_read));
        }
        cmp::Ordering::Greater => {
          buf[..buffer_len].copy_from_slice(this.buffer);
          buf = &mut buf[buffer_len..];
          match this.reader.poll_read(cx, buf) {
            Poll::Ready(Ok(bytes)) => {
              this.buffer.clear();
              Poll::Ready(Ok(bytes + buffer_len))
            }
            Poll::Ready(Err(e)) => Poll::Ready(Err(e)),
            Poll::Pending => {
              this.buffer.clear();
              Poll::Ready(Ok(buffer_len))
            }
          }
        }
      };
    }

    this.reader.poll_read(cx, buf)
  }
}

impl<R: AsyncRead> AsyncPeek for AsyncPeekable<R> {
  fn poll_peek(self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8]) -> Poll<Result<usize>> {
    let want_peek = buf.len();

    // check if the peek buffer has data
    let buffer_len = self.buffer.len();

    if buffer_len > 0 {
      return match want_peek.cmp(&buffer_len) {
        cmp::Ordering::Less => {
          buf.copy_from_slice(&self.buffer[..want_peek]);
          Poll::Ready(Ok(want_peek))
        }
        cmp::Ordering::Equal => {
          buf.copy_from_slice(&self.buffer);
          Poll::Ready(Ok(want_peek))
        }
        cmp::Ordering::Greater => {
          let this = self.project();
          this.buffer.resize(want_peek, 0);
          match this.reader.poll_read(cx, &mut this.buffer[buffer_len..]) {
            Poll::Ready(Ok(n)) => {
              this.buffer.truncate(n + buffer_len);
              buf[..buffer_len + n].copy_from_slice(this.buffer);
              Poll::Ready(Ok(buffer_len + n))
            }
            Poll::Ready(Err(e)) => Poll::Ready(Err(e)),
            Poll::Pending => {
              buf[..buffer_len].copy_from_slice(this.buffer);
              Poll::Ready(Ok(buffer_len))
            }
          }
        }
      };
    }

    let this = self.project();
    match this.reader.poll_read(cx, buf) {
      Poll::Ready(Ok(bytes)) => {
        this.buffer.extend_from_slice(&buf[..bytes]);
        Poll::Ready(Ok(bytes))
      }
      Poll::Ready(Err(e)) => Poll::Ready(Err(e)),
      Poll::Pending => Poll::Pending,
    }
  }
}

impl<R> AsyncPeekable<R> {
  /// Creates a new `AsyncPeekable` which will wrap the given reader.
  ///
  /// The peek buffer will have the default capacity.
  ///
  /// # Examples
  ///
  /// ```rust
  /// use peekable::future::AsyncPeekable;
  ///
  /// # futures::executor::block_on(async {
  /// let reader = futures::io::Cursor::new(&b"hello"[..]);
  /// let peekable = AsyncPeekable::new(reader);
  /// # });
  ///
  #[inline]
  pub fn new(reader: R) -> Self {
    Self {
      reader,
      buffer: Buffer::new(),
    }
  }

  /// Creates a new peekable wrapper around the given reader with the specified
  /// capacity for the peek buffer.
  ///
  /// # Examples
  ///
  /// ```rust
  /// use peekable::future::AsyncPeekable;
  ///
  /// # futures::executor::block_on(async {
  /// let reader = futures::io::Cursor::new([0; 1024]);
  /// let peekable = AsyncPeekable::with_capacity(reader, 1024);
  /// # });
  #[inline]
  pub fn with_capacity(reader: R, capacity: usize) -> Self {
    Self {
      reader,
      buffer: Buffer::with_capacity(capacity),
    }
  }

  /// Consumes the peek buffer and returns the buffer.
  ///
  /// # Examples
  ///
  /// ```rust
  /// use peekable::future::AsyncPeekable;
  ///
  /// # futures::executor::block_on(async {
  /// let reader = futures::io::Cursor::new([1, 2, 3, 4]);
  /// let mut peekable = AsyncPeekable::from(reader);
  ///
  /// let mut output = [0u8; 2];
  /// let bytes = peekable.peek(&mut output).await.unwrap();
  /// assert_eq!(bytes, 2);
  /// assert_eq!(output, [1, 2]);
  ///
  /// let buffer = peekable.consume();
  /// assert_eq!(buffer.as_slice(), [1, 2].as_slice());
  ///
  /// let mut output = [0u8; 2];
  /// let bytes = peekable.peek(&mut output).await.unwrap();
  /// assert_eq!(bytes, 2);
  /// assert_eq!(output, [3, 4]);
  /// # });
  /// ```
  #[inline]
  pub fn consume(&mut self) -> Buffer {
    mem::take(&mut self.buffer)
  }

  /// Consumes the peek buffer in place so that the peek buffer can be reused and avoid allocating.
  ///
  /// # Examples
  ///
  /// ```rust
  /// use peekable::future::AsyncPeekable;
  ///
  /// # futures::executor::block_on(async {
  /// let reader = futures::io::Cursor::new([1, 2, 3, 4]);
  /// let mut peekable = AsyncPeekable::from(reader);
  ///
  /// let mut output = [0u8; 2];
  /// let bytes = peekable.peek(&mut output).await.unwrap();
  /// assert_eq!(bytes, 2);
  /// assert_eq!(output, [1, 2]);
  ///
  /// peekable.consume_in_place();
  ///
  /// let mut output = [0u8; 2];
  /// let bytes = peekable.peek(&mut output).await.unwrap();
  /// assert_eq!(bytes, 2);
  /// assert_eq!(output, [3, 4]);
  /// # });
  /// ```
  #[inline]
  pub fn consume_in_place(&mut self) {
    self.buffer.clear();
  }

  /// Returns the bytes already be peeked into memory and a mutable reference to the underlying reader.
  ///
  /// **WARNING: If you invoke `AsyncRead` or `AsyncReadExt` methods on the underlying reader, may lead to unexpected read behaviors.**
  ///
  /// # Examples
  ///
  /// ```rust
  /// use peekable::future::AsyncPeekable;
  ///
  /// # futures::executor::block_on(async {
  /// let reader = futures::io::Cursor::new([1, 2, 3, 4]);
  /// let mut peekable = AsyncPeekable::from(reader);
  ///
  /// let mut output = [0u8; 2];
  /// let bytes = peekable.peek(&mut output).await.unwrap();
  /// assert_eq!(bytes, 2);
  /// assert_eq!(output, [1, 2]);
  ///
  /// let (buffer, reader) = peekable.get_mut();
  /// assert_eq!(buffer, [1, 2].as_slice());
  /// # });
  /// ````
  #[inline]
  pub fn get_mut(&mut self) -> (&[u8], &mut R) {
    (&self.buffer, &mut self.reader)
  }

  /// Returns the bytes already be peeked into memory and a reference to the underlying reader.
  ///
  /// **WARNING: If you invoke `AsyncRead` or `AsyncReadExt` methods on the underlying reader, may lead to unexpected read behaviors.**
  ///
  /// # Examples
  ///
  /// ```rust
  /// use peekable::future::AsyncPeekable;
  ///
  /// # futures::executor::block_on(async {
  /// let reader = futures::io::Cursor::new([1, 2, 3, 4]);
  /// let mut peekable = AsyncPeekable::from(reader);
  ///
  /// let mut output = [0u8; 2];
  /// let bytes = peekable.peek(&mut output).await.unwrap();
  /// assert_eq!(bytes, 2);
  /// assert_eq!(output, [1, 2]);
  ///
  /// let (buffer, reader) = peekable.get_ref();
  /// assert_eq!(buffer, [1, 2].as_slice());
  /// # });
  #[inline]
  pub fn get_ref(&self) -> (&[u8], &R) {
    (&self.buffer, &self.reader)
  }

  /// Consumes the `AsyncPeekable`, returning the a vec may contain the bytes already be peeked into memory and the wrapped reader.
  ///
  /// # Examples
  ///
  /// ```rust
  /// use peekable::future::AsyncPeekable;
  ///
  /// # futures::executor::block_on(async {
  /// let reader = futures::io::Cursor::new([1, 2, 3, 4]);
  /// let mut peekable = AsyncPeekable::from(reader);
  ///
  /// let mut output = [0u8; 2];
  /// let bytes = peekable.peek(&mut output).await.unwrap();
  /// assert_eq!(bytes, 2);
  /// assert_eq!(output, [1, 2]);
  ///
  /// let (buffer, reader) = peekable.into_components();
  /// assert_eq!(buffer.as_slice(), [1, 2].as_slice());
  /// # });
  #[inline]
  pub fn into_components(self) -> (Buffer, R) {
    (self.buffer, self.reader)
  }
}

impl<R: AsyncRead + Unpin> AsyncPeekable<R> {
  /// Tries to peek some bytes directly into the given `buf` in asynchronous
  /// manner, returning a future type.
  ///
  /// The returned future will resolve to the number of bytes read once the read
  /// operation is completed.
  ///
  /// # Examples
  ///
  /// ```
  /// # futures::executor::block_on(async {
  /// use futures::io::{AsyncReadExt, Cursor};
  /// use peekable::future::AsyncPeekExt;
  ///
  ///
  /// let mut peekable = Cursor::new([1, 2, 3, 4]).peekable();
  /// let mut output = [0u8; 5];
  ///
  /// let bytes = peekable.peek(&mut output[..3]).await?;
  ///
  /// // This is only guaranteed to be 4 because `&[u8]` is a synchronous
  /// // reader. In a real system you could get anywhere from 1 to
  /// // `output.len()` bytes in a single read.
  /// assert_eq!(bytes, 3);
  /// assert_eq!(output, [1, 2, 3, 0, 0]);
  ///
  /// // you can peek mutiple times
  ///
  /// let bytes = peekable.peek(&mut output[..]).await?;
  /// assert_eq!(bytes, 4);
  /// assert_eq!(output, [1, 2, 3, 4, 0]);
  ///
  /// // you can read after peek
  /// let mut output = [0u8; 5];
  /// let bytes = peekable.read(&mut output[..2]).await?;
  /// assert_eq!(bytes, 2);
  /// assert_eq!(output, [1, 2, 0, 0, 0]);
  ///
  /// // peek after read
  /// let mut output = [0u8; 5];
  /// let bytes = peekable.peek(&mut output[..]).await?;
  /// assert_eq!(bytes, 2);
  /// assert_eq!(output, [3, 4, 0, 0, 0]);
  ///
  /// # Ok::<(), Box<dyn std::error::Error>>(()) }).unwrap();
  /// ```
  pub fn peek<'a>(&'a mut self, buf: &'a mut [u8]) -> Peek<'a, R>
  where
    Self: Unpin,
  {
    assert_future(Peek::new(self, buf))
  }

  /// Creates a future which will peek from the `AsyncPeek` into `bufs` using vectored
  /// IO operations.
  ///
  /// The returned future will resolve to the number of bytes read once the read
  /// operation is completed.
  pub fn peek_vectored<'a>(&'a mut self, bufs: &'a mut [IoSliceMut<'a>]) -> PeekVectored<'a, R>
  where
    Self: Unpin,
  {
    assert_future(PeekVectored::new(self, bufs))
  }

  /// Creates a future which will peek exactly enough bytes to fill `buf`,
  /// returning an error if end of file (EOF) is hit sooner.
  ///
  /// The returned future will resolve once the read operation is completed.
  ///
  /// In the case of an error the buffer and the object will be discarded, with
  /// the error yielded.
  ///
  /// # Examples
  ///
  /// ```rust
  /// # futures::executor::block_on(async {
  /// use futures::io::{AsyncReadExt, Cursor};
  /// use peekable::future::AsyncPeekExt;
  ///
  /// let mut peekable = Cursor::new([1, 2, 3, 4]).peekable();
  /// let mut output = [0u8; 4];
  ///
  /// peekable.peek_exact(&mut output).await?;
  ///
  /// assert_eq!(output, [1, 2, 3, 4]);
  ///
  /// // read after peek
  /// let mut output = [0u8; 2];
  ///
  /// peekable.read_exact(&mut output[..]).await?;
  ///
  /// assert_eq!(output, [1, 2]);
  ///
  /// // peek after read
  /// let mut output = [0u8; 2];
  /// peekable.peek_exact(&mut output).await?;
  ///
  /// assert_eq!(output, [3, 4]);
  ///
  /// # Ok::<(), Box<dyn std::error::Error>>(()) }).unwrap();
  /// ```
  ///
  /// ## EOF is hit before `buf` is filled
  ///
  /// ```
  /// # futures::executor::block_on(async {
  /// use futures::io::{self, AsyncReadExt, Cursor};
  /// use peekable::future::AsyncPeekExt;
  ///
  /// let mut peekable = Cursor::new([1, 2, 3, 4]).peekable();
  /// let mut output = [0u8; 5];

  /// let result = peekable.peek_exact(&mut output).await;
  /// assert_eq!(
  ///   result.unwrap_err().kind(),
  ///   std::io::ErrorKind::UnexpectedEof
  /// );

  /// let result = peekable.peek_exact(&mut output[..4]).await;
  /// assert!(result.is_ok());
  /// assert_eq!(output, [1, 2, 3, 4, 0]);
  /// # });
  /// ```
  pub fn peek_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> PeekExact<'a, R>
  where
    Self: Unpin,
  {
    assert_future::<Result<()>, _>(PeekExact::new(self, buf))
  }

  /// Creates a future which will peek all the bytes from this `AsyncPeek`.
  ///
  /// On success the total number of bytes peek is returned.
  ///
  /// # Examples
  ///
  /// ```
  /// # futures::executor::block_on(async {
  /// use futures::io::{AsyncReadExt, Cursor};
  /// use peekable::future::AsyncPeekExt;
  ///
  /// let mut peekable = Cursor::new([1, 2, 3, 4]).peekable();
  /// let mut output = Vec::with_capacity(4);
  ///
  /// let bytes = peekable.peek_to_end(&mut output).await?;
  ///
  /// assert_eq!(bytes, 4);
  /// assert_eq!(output, vec![1, 2, 3, 4]);
  ///
  /// // read after peek
  /// let mut output = Vec::with_capacity(4);
  ///
  /// let bytes = peekable.read_to_end(&mut output).await?;
  ///
  /// assert_eq!(bytes, 4);
  /// assert_eq!(output, vec![1, 2, 3, 4]);
  ///
  /// # Ok::<(), Box<dyn std::error::Error>>(()) }).unwrap();
  /// ```
  pub fn peek_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> PeekToEnd<'a, R>
  where
    Self: Unpin,
  {
    assert_future::<Result<usize>, _>(PeekToEnd::new(self, buf))
  }

  /// Creates a future which will peek all the bytes from this `AsyncPeek`.
  ///
  /// On success the total number of bytes peek is returned.
  ///
  /// # Examples
  ///
  /// ```
  /// # futures::executor::block_on(async {
  /// use futures::io::{AsyncReadExt, Cursor};
  /// use peekable::future::AsyncPeekExt;
  ///
  /// let mut peekable = Cursor::new(&b"1234"[..]).peekable();
  /// let mut buffer = String::with_capacity(4);
  ///
  /// let bytes = peekable.peek_to_string(&mut buffer).await?;
  ///
  /// assert_eq!(bytes, 4);
  /// assert_eq!(buffer, String::from("1234"));
  ///
  /// // read after peek
  /// let mut buffer = String::with_capacity(4);
  /// let bytes = peekable.peek_to_string(&mut buffer).await?;
  ///
  /// assert_eq!(bytes, 4);
  /// assert_eq!(buffer, String::from("1234"));
  ///
  /// // peek invalid utf-8
  /// let mut peekable = Cursor::new([255; 4]).peekable();
  /// let mut buffer = String::with_capacity(4);
  /// assert!(peekable.peek_to_string(&mut buffer).await.is_err());
  /// # Ok::<(), Box<dyn std::error::Error>>(()) }).unwrap();
  /// ```
  pub fn peek_to_string<'a>(&'a mut self, buf: &'a mut String) -> PeekToString<'a, R>
  where
    Self: Unpin,
  {
    assert_future::<Result<usize>, _>(PeekToString::new(self, buf))
  }

  /// Try to fill the peek buffer with more data. Returns the number of bytes peeked.
  ///
  /// # Examples
  ///
  /// ```rust
  /// use futures::io::Cursor;
  /// use futures::AsyncReadExt;
  /// use peekable::future::AsyncPeekExt;
  ///
  /// # futures::executor::block_on(async {
  ///
  /// let mut peekable = Cursor::new([1, 2, 3, 4]).peekable_with_capacity(5);
  /// let mut output = [0u8; 4];
  ///
  /// peekable.peek_exact(&mut output[..1]).await.unwrap();
  /// assert_eq!(output, [1, 0, 0, 0]);
  ///
  /// let bytes = peekable.fill_peek_buf().await.unwrap();
  /// assert_eq!(bytes, 3);
  ///
  /// let bytes = peekable.peek(&mut output).await.unwrap();
  /// assert_eq!(output, [1, 2, 3, 4].as_slice());
  ///
  /// let readed = peekable.read(&mut output).await.unwrap();
  /// assert_eq!(readed, 4);
  /// # });
  /// ````
  pub fn fill_peek_buf(&mut self) -> FillPeekBuf<'_, R> {
    assert_future::<Result<usize>, _>(FillPeekBuf::new(self))
  }
}

/// An extension trait which adds peek related utility methods to [`AsyncRead`] types
pub trait AsyncPeekExt: AsyncRead {
  /// Creates a new `AsyncPeekable` which will wrap the given reader.
  fn peekable(self) -> AsyncPeekable<Self>
  where
    Self: Sized,
  {
    AsyncPeekable {
      reader: self,
      buffer: Buffer::new(),
    }
  }

  /// Wraps a [`Read`] type in a `Peekable` which provides a `peek` related methods with a specified capacity.
  fn peekable_with_capacity(self, capacity: usize) -> AsyncPeekable<Self>
  where
    Self: Sized,
  {
    AsyncPeekable {
      reader: self,
      buffer: Buffer::with_capacity(capacity),
    }
  }
}

impl<R: AsyncRead> AsyncPeekExt for R {}

// impl<R: AsyncPeek + ?Sized> AsyncPeekExt for R {}

// Just a helper function to ensure the futures we're returning all have the
// right implementations.
pub(crate) fn assert_future<T, F>(future: F) -> F
where
  F: Future<Output = T>,
{
  future
}

#[cfg(test)]
mod tests {
  use super::*;
  use futures::io::{AsyncReadExt, Cursor};

  #[test]
  fn test_peek_exact_peek_exact_read_exact() {
    futures::executor::block_on(async move {
      let mut peekable = Cursor::new([1, 2, 3, 4, 5, 6, 7, 8, 9]).peekable();
      let mut buf1 = [0; 2];
      peekable.peek_exact(&mut buf1).await.unwrap();
      assert_eq!(buf1, [1, 2]);

      let mut buf2 = [0; 4];
      peekable.peek_exact(&mut buf2).await.unwrap();
      assert_eq!(buf2, [1, 2, 3, 4]);

      let mut buf3 = [0; 4];
      peekable.read_exact(&mut buf3).await.unwrap();
      assert_eq!(buf3, [1, 2, 3, 4]);
    });
  }
}