buffer_pool/
raw_pool_buf_io.rs

1// Copyright (C) 2025, Cloudflare, Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//
11//     * Redistributions in binary form must reproduce the above copyright
12//       notice, this list of conditions and the following disclaimer in the
13//       documentation and/or other materials provided with the distribution.
14//
15// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
16// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
17// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
19// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27use std::io;
28use std::task::Context;
29use std::task::Poll;
30
31use crate::ConsumeBuffer;
32use crate::Pooled;
33
34pub type PooledBuf = Pooled<ConsumeBuffer>;
35
36/// A trait to optimize read and write operations on pooled buffers.
37pub trait RawPoolBufIo: Send {
38    fn poll_send_reserve(&mut self, cx: &mut Context) -> Poll<io::Result<()>>;
39
40    fn send_buf(&mut self, buf: PooledBuf, fin: bool) -> io::Result<()>;
41
42    fn poll_recv_buf(&mut self, cx: &mut Context) -> Poll<io::Result<PooledBuf>>;
43}
44
45pub trait RawPoolBufDatagramIo: Send {
46    fn poll_send_datagrams(
47        &mut self, cx: &mut Context, datagrams: &mut [PooledBuf],
48    ) -> Poll<io::Result<usize>>;
49
50    fn poll_recv_dgram(
51        &mut self, cx: &mut Context,
52    ) -> Poll<io::Result<PooledBuf>>;
53
54    fn poll_recv_datagrams(
55        &mut self, cx: &mut Context, buffer: &mut Vec<PooledBuf>, limit: usize,
56    ) -> Poll<io::Result<usize>> {
57        for i in 0..limit {
58            match self.poll_recv_dgram(cx) {
59                Poll::Ready(Ok(buf)) => buffer.push(buf),
60                Poll::Ready(Err(err)) =>
61                    if i > 0 {
62                        return Poll::Ready(Ok(i));
63                    } else {
64                        return Poll::Ready(Err(err));
65                    },
66                Poll::Pending =>
67                    if i > 0 {
68                        return Poll::Ready(Ok(i));
69                    } else {
70                        return Poll::Pending;
71                    },
72            }
73        }
74
75        Poll::Ready(Ok(limit))
76    }
77}
buffer_pool/raw_pool_buf_io.rs

buffer_pool/
raw_pool_buf_io.rs
