unbytes 0.5.0

Panic-free reading of bytes.
Documentation 
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

use core::ops::{Deref, DerefMut};
use crate::*;

impl Reader {
    /// Returns a [`ReaderMayPanic`].
    /// This crate's no-panic guarantee is forfeited if this function is used.
    #[inline]
    pub fn may_panic(&mut self) -> ReaderMayPanic {
        ReaderMayPanic(self)
    }
}

/// A usage of a [`Reader`] that can panic, but exposes further APIs as a result.
pub struct ReaderMayPanic<'a>(&'a mut Reader);

impl AsMut<Reader> for ReaderMayPanic<'_> {
    fn as_mut(&mut self) -> &mut Reader {
        &mut self.0
    }
}

impl<'a> Deref for ReaderMayPanic<'a> {
    type Target = Reader;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<'a> DerefMut for ReaderMayPanic<'a> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.0
    }
}

impl<'a> Buf for ReaderMayPanic<'a> {
    #[inline]
    fn remaining(&self) -> usize {
        self.0.remaining()
    }

    fn chunk(&self) -> &[u8] {
        &self.inner[self.index..]
    }

    #[inline]
    fn advance(&mut self, cnt: usize) {
        self.0.increment(cnt)
    }

    #[inline]
    fn copy_to_bytes(&mut self, len: usize) -> bytes::Bytes {
        self.read_bytes(len).unwrap()
    }
}