A segmented list of bytes::Bytes chunks.
This crate provides a BufList type that is a list of Bytes chunks.
The type implements bytes::Buf, so it can be used in any APIs that use Buf.
The main use case for BufList is to buffer data received as a stream of chunks without
having to copy them into a single contiguous chunk of memory. The BufList can then be passed
into any APIs that accept Buf.
If you've ever wanted a Vec<Bytes> or a VecDeque<Bytes>, this type is for you.
Gather chunks into a BufList, then write them all out to standard error in one go:
```rust use buf_list::BufList; use tokio::io::AsyncWriteExt;
let mut buflist = BufList::new(); buflist.pushchunk(&b"hello "[..]); buflist.pushchunk(&b"world"[..]); buflist.push_chunk(&b"!"[..]);
let mut stderr = tokio::io::stderr(); stderr.writeallbuf(&mut buf_list).await?; ```
Collect a fallible stream of Bytes into a BufList:
```rust use buf_list::BufList; use bytes::Bytes; use futures::stream::TryStreamExt;
// A common example is a stream of bytes read over HTTP. let stream = futures::stream::iter( vec![ Ok(Bytes::fromstatic(&b"laputa, "[..])), Ok(Bytes::fromstatic(&b"castle "[..])), Ok(Bytes::from_static(&b"in the sky"[..])) ], );
let buflist = stream.trycollect::
The minimum supported Rust version (MSRV) is 1.39, same as the bytes crate.
The MSRV is not expected to change in the future. If it does, it will be done as a breaking change.
Pull requests are welcome! Please follow the code of conduct.
buf-list is copyright 2022 The buf-list Contributors. All rights reserved.
Copied and adapted from linkerd2-proxy; original code written by Eliza Weisman. linkerd2-proxy is copyright 2018 the linkerd2-proxy authors. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.