buf-list 1.1.2

A list of buffers that implements the bytes::Buf trait
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
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

// Copyright (c) The buf-list Contributors
// SPDX-License-Identifier: Apache-2.0

use buf_list::BufList;
use bytes::{Buf, Bytes};
use std::{io::IoSlice, ops::Deref};

#[test]
fn test_basic() {
    let mut buf_list = vec![&b"hello"[..], &b"world"[..]]
        .into_iter()
        .collect::<BufList>();
    println!("{:?}", buf_list);
    assert_eq!(buf_list.num_bytes(), 10);
    assert_eq!(buf_list.num_chunks(), 2);

    let chunk = buf_list.push_chunk(&b"foo"[..]);
    assert_eq!(buf_list.num_bytes(), 13);
    assert_eq!(buf_list.num_chunks(), 3);
    assert_eq!(chunk, &b"foo"[..]);

    // Try inserting a zero-length chunk. This should not count as a chunk.
    buf_list.push_chunk(&[] as &[u8]);
    assert_eq!(buf_list.num_bytes(), 13);
    assert_eq!(buf_list.num_chunks(), 3);

    {
        let mut buf_list = buf_list.clone();

        assert_eq!(buf_list.chunk(), &b"hello"[..]);

        // Advance by 2. This won't consume the first chunk.
        buf_list.advance(2);
        assert_eq!(buf_list.num_bytes(), 11);
        assert_eq!(buf_list.num_chunks(), 3);
        assert_eq!(buf_list.chunk(), &b"llo"[..]);

        // Advance by 3. This will consume the "hello" chunk exactly.
        buf_list.advance(3);
        assert_eq!(buf_list.num_bytes(), 8);
        assert_eq!(buf_list.num_chunks(), 2);
        assert_eq!(buf_list.chunk(), &b"world"[..]);

        // Advance by 6. This will consume the "world" chunk + the first byte of "foo".
        buf_list.advance(6);
        assert_eq!(buf_list.num_bytes(), 2);
        assert_eq!(buf_list.num_chunks(), 1);
        assert_eq!(buf_list.chunk(), &b"oo"[..]);

        // Advance by 2. This will consume the "foo" chunk exactly.
        buf_list.advance(2);
        assert_eq!(buf_list.num_bytes(), 0);
        assert_eq!(buf_list.num_chunks(), 0);
        assert_eq!(buf_list.chunk(), &[] as &[u8]);
    }

    {
        // Test chunks_vectored.
        let mut chunks_vectored = vec![IoSlice::new(&[]); 5];
        let ret = buf_list.chunks_vectored(&mut chunks_vectored);
        assert_eq!(ret, 3);
        assert_eq!(chunks_vectored[0].deref(), &b"hello"[..]);
        assert_eq!(chunks_vectored[1].deref(), &b"world"[..]);
        assert_eq!(chunks_vectored[2].deref(), &b"foo"[..]);
        assert_eq!(chunks_vectored[3].deref(), &[] as &[u8]);

        // Test chunks_vectored with a smaller buffer.
        let mut chunks_vectored = vec![IoSlice::new(&[]); 2];
        let ret = buf_list.chunks_vectored(&mut chunks_vectored);
        assert_eq!(ret, 2);
        assert_eq!(chunks_vectored[0].deref(), &b"hello"[..]);
        assert_eq!(chunks_vectored[1].deref(), &b"world"[..]);

        // Test with an empty buffer.
        let mut chunks_vectored = vec![];
        let ret = buf_list.chunks_vectored(&mut chunks_vectored);
        assert_eq!(ret, 0);
    }

    {
        // Test copy_to_bytes.
        let mut buf_list = buf_list.clone();

        // Copy the first two bytes -- this should just be a refcount.
        let bytes = buf_list.copy_to_bytes(2);
        assert_eq!(bytes, &b"he"[..]);
        assert_eq!(buf_list.num_bytes(), 11);
        assert_eq!(buf_list.num_chunks(), 3);

        // Copy the next 3 bytes. This should consume the buffer.
        let bytes = buf_list.copy_to_bytes(3);
        assert_eq!(bytes, &b"llo"[..]);
        assert_eq!(buf_list.num_bytes(), 8);
        assert_eq!(buf_list.num_chunks(), 2);

        // Copy 6 bytes. This should consume the next buffer.
        let bytes = buf_list.copy_to_bytes(6);
        assert_eq!(bytes, &b"worldf"[..]);
        assert_eq!(buf_list.num_bytes(), 2);
        assert_eq!(buf_list.num_chunks(), 1);

        // Copy the last 2 bytes + this next buffer -- ensure that all buffers are consumed.
        buf_list.push_chunk(&b"bar"[..]);
        let bytes = buf_list.copy_to_bytes(5);
        assert_eq!(bytes, &b"oobar"[..]);
        assert_eq!(buf_list.num_bytes(), 0);
        assert_eq!(buf_list.num_chunks(), 0);
    }
}

#[test]
fn test_iter() {
    let buf_list = vec![&b"hello"[..], &b"world"[..], &b"foo"[..], &b"bar"[..]]
        .into_iter()
        .collect::<BufList>();

    // Test iteration over the buf_list.
    let mut iter = (&buf_list).into_iter();
    println!("{:?}", iter);
    assert_eq!(iter.next(), Some(&Bytes::from_static(&b"hello"[..])));
    assert_eq!(iter.size_hint(), (3, Some(3)));
    assert_eq!(iter.len(), 3);

    {
        let mut iter = iter.clone();
        #[allow(clippy::iter_nth_zero)]
        {
            assert_eq!(iter.nth(0), Some(&Bytes::from_static(&b"world"[..])));
        }
        assert_eq!(iter.last(), Some(&Bytes::from_static(&b"bar"[..])));
    }

    {
        let iter = iter.clone();
        let v = iter.fold(vec![], |mut v, item| {
            v.push(item);
            v
        });
        assert_eq!(
            v,
            vec![
                &Bytes::from_static(&b"world"[..]),
                &Bytes::from_static(&b"foo"[..]),
                &Bytes::from_static(&b"bar"[..]),
            ]
        );
    }

    {
        let mut iter = iter.clone();
        assert_eq!(iter.next_back(), Some(&Bytes::from_static(&b"bar"[..])));
        assert_eq!(
            iter.rfold(vec![], |mut v, item| {
                v.push(item);
                v
            }),
            vec![
                &Bytes::from_static(&b"foo"[..]),
                &Bytes::from_static(&b"world"[..]),
            ]
        );
    }
}

#[test]
fn test_into_iter() {
    let buf_list = vec![&b"hello"[..], &b"world"[..], &b"foo"[..], &b"bar"[..]]
        .into_iter()
        .collect::<BufList>();

    let into_iter = buf_list.into_iter();
    println!("{:?}", into_iter);
    #[allow(clippy::redundant_clone)]
    let mut into_iter = into_iter.clone();
    assert_eq!(into_iter.next(), Some(Bytes::from_static(&b"hello"[..])));
    assert_eq!(into_iter.size_hint(), (3, Some(3)));
    assert_eq!(into_iter.len(), 3);
    assert_eq!(into_iter.next_back(), Some(Bytes::from_static(&b"bar"[..])));
}

#[test]
#[should_panic = "`len` (12) greater than remaining (10)"]
fn test_copy_to_bytes_panic() {
    let mut buf_list = vec![&b"hello"[..], &b"world"[..]]
        .into_iter()
        .collect::<BufList>();
    buf_list.copy_to_bytes(12);
}