layered-io 0.23.1

I/O traits extending Read and Write
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
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

use std::ops::DerefMut;
use std::pin::Pin;

/// A trait to help with buffering on top of `ReadLayered` and `WriteLayered`.
pub trait Bufferable {
    /// Close the resource and abandon any pending buffered contents or errors.
    fn abandon(&mut self);

    /// A suggested size, in bytes, for buffering for performance.
    #[inline]
    fn suggested_buffer_size(&self) -> usize {
        default_suggested_buffer_size(self)
    }
}

/// Default implementation of `Bufferable::abandon`, which does nothing.
#[inline]
pub fn default_suggested_buffer_size<Inner: Bufferable + ?Sized>(_inner: &Inner) -> usize {
    // At the time of this writing, this is the same as `DEFAULT_BUF_SIZE`
    // in libstd.
    0x2000
}

impl<B: Bufferable> Bufferable for Box<B> {
    #[inline]
    fn abandon(&mut self) {
        self.as_mut().abandon()
    }

    #[inline]
    fn suggested_buffer_size(&self) -> usize {
        self.as_ref().suggested_buffer_size()
    }
}

impl<B: Bufferable> Bufferable for &mut B {
    #[inline]
    fn abandon(&mut self) {
        (**self).abandon()
    }

    #[inline]
    fn suggested_buffer_size(&self) -> usize {
        (**self).suggested_buffer_size()
    }
}

impl Bufferable for std::io::Cursor<Vec<u8>> {
    #[inline]
    fn abandon(&mut self) {
        self.set_position(self.get_ref().len().try_into().unwrap())
    }

    #[inline]
    fn suggested_buffer_size(&self) -> usize {
        0
    }
}

impl Bufferable for std::io::Cursor<Box<[u8]>> {
    #[inline]
    fn abandon(&mut self) {
        self.set_position(self.get_ref().len().try_into().unwrap())
    }

    #[inline]
    fn suggested_buffer_size(&self) -> usize {
        0
    }
}

impl Bufferable for std::io::Cursor<&mut Vec<u8>> {
    #[inline]
    fn abandon(&mut self) {
        self.set_position(self.get_ref().len().try_into().unwrap())
    }

    #[inline]
    fn suggested_buffer_size(&self) -> usize {
        0
    }
}

impl Bufferable for std::io::Cursor<&mut [u8]> {
    #[inline]
    fn abandon(&mut self) {
        self.set_position(self.get_ref().len().try_into().unwrap())
    }

    #[inline]
    fn suggested_buffer_size(&self) -> usize {
        0
    }
}

impl<P> Bufferable for Pin<P>
where
    P: DerefMut + Unpin,
    P::Target: Bufferable + Unpin,
{
    #[inline]
    fn abandon(&mut self) {
        Pin::get_mut(self.as_mut()).abandon()
    }

    #[inline]
    fn suggested_buffer_size(&self) -> usize {
        self.as_ref().suggested_buffer_size()
    }
}