fixed-buffer

这是一个 Rust 库，具有固定大小的缓冲区，适用于网络协议解析器和文件解析器。

特性

• 禁止(不安全代码)
• 仅依赖 std
• 将字节写入缓冲区并读取它们
• 位于栈上
• 不分配
• 使用它读取流，搜索分隔符，并将剩余字节保存用于下一次读取。
• 无宏
• 良好的测试覆盖率（99%）
• 通过启用 cargo 功能 async-std-feature，futures-io，smol-feature 或 tokio 支持异步。

限制

• 不是一个循环缓冲区。您可以定期调用 shift() 将未读取的字节移动到缓冲区的开头。

示例

读取并处理来自远程客户端的请求

use fixed_buffer::{deframe_line, FixedBuf};
use std::io::Error;
use std::net::TcpStream;

fn handle_conn(mut tcp_stream: TcpStream) -> Result<(), Error> {
    let mut buf: FixedBuf<4096> = FixedBuf::new();
    loop {
        // Read a line
        // and leave leftover bytes in `buf`.
        let line_bytes = match buf.read_frame(
            &mut tcp_stream, deframe_line)? {
                Some(line_bytes) => line_bytes,
                None => return Ok(()),
            };
        let request = Request::parse(line_bytes)?;
        handle_request(request)?;
    }
}

完整的示例，请参阅 tests/server.rs.

读取并处理记录

use fixed_buffer::FixedBuf;
use std::io::{Error, ErrorKind, Read};
use std::net::TcpStream;

fn try_process_record(b: &[u8]) -> Result<usize, Error> {
    if b.len() < 2 {
        return Ok(0);
    }
    if b.starts_with("ab".as_bytes()) {
        println!("found record");
        Ok(2)
    } else {
        Err(Error::new(ErrorKind::InvalidData, "bad record"))
    }
}

fn read_and_process<R: Read>(mut input: R) -> Result<(), Error> {
    let mut buf: FixedBuf<1024> = FixedBuf::new();
    loop {
        // Read a chunk into the buffer.
        if buf.copy_once_from(&mut input)? == 0 {
            return if buf.len() == 0 {
                // EOF at record boundary
                Ok(())
            } else {
                // EOF in the middle of a record
                Err(Error::from(
                    ErrorKind::UnexpectedEof))
            };
        }
        // Process records in the buffer.
        loop {
            let num_to_consume =
                try_process_record(buf.readable())?;
            if num_to_consume == 0 {
                break;
            }
            buf.try_read_exact(num_to_consume).unwrap();
        }
        // Shift data in the buffer to free up
        // space at the end for writing.
        buf.shift();
    }
}
#

From<[u8; SIZE]> 的实现对测试很有用。示例

use core::convert::From;
assert_eq!(3, FixedBuf::from(*b"abc").len());

替代方案

• bytes
• buf_redux，支持循环缓冲区
• std::io::BufReader
• std::io::BufWriter
• static-buffer，于2016年更新
• block-buffer，用于处理固定长度的数据块
• arrayvec，具有固定容量的向量。

变更日志

• v0.5.0 - 将 ReadWriteChain 和 ReadWriteTake 移动到新的 read-write-ext 包。
• v0.4.0
  • 从<&[u8]>
  • 将 write_bytes 修改为 AsRef<[u8]>
  • 将 try_read_exact 修改为 read_and_copy_exact。
  • 将 try_read_bytes 修改为 try_read_exact。
  • 移除 empty、filled、read_byte、read_bytes、try_parse 和 write_str。
  • deframe 允许在不返回框架的情况下消耗字节
  • write_bytes 尽可能写入字节，并在无法写入任何字节时返回新的 NoWritableSpace 错误。移除 NotEnoughSpaceError。现在该方法的行为类似于 std::io::Write::write。
• v0.3.1 - 实现 From<NotEnoughSpaceError> 和 From<MalformedInputError> 对 String。