compio_buf/
lib.rs

1//! Utilities for working with buffers.
2//!
3//! Completion APIs require passing ownership of buffers to the runtime. The
4//! crate defines [`IoBuf`] and [`IoBufMut`] traits which are implemented by
5//! buffer types that respect the safety contract.
6
7#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
8#![cfg_attr(feature = "allocator_api", feature(allocator_api))]
9#![cfg_attr(feature = "read_buf", feature(read_buf, core_io_borrowed_buf))]
10#![cfg_attr(feature = "try_trait_v2", feature(try_trait_v2, try_trait_v2_residual))]
11#![warn(missing_docs)]
12
13#[cfg(feature = "arrayvec")]
14pub use arrayvec;
15#[cfg(feature = "bumpalo")]
16pub use bumpalo;
17#[cfg(feature = "bytes")]
18pub use bytes;
19
20mod io_slice;
21pub use io_slice::*;
22
23mod buf_result;
24pub use buf_result::*;
25
26mod io_buf;
27pub use io_buf::*;
28
29mod io_vec_buf;
30pub use io_vec_buf::*;
31
32mod slice;
33pub use slice::*;
34
35mod uninit;
36pub use uninit::*;
37
38mod iter;
39pub use iter::*;
40
41/// Trait to get the inner buffer of an operation or a result.
42pub trait IntoInner {
43    /// The inner type.
44    type Inner;
45
46    /// Get the inner buffer.
47    fn into_inner(self) -> Self::Inner;
48}
49
50#[cfg(not(feature = "allocator_api"))]
51#[macro_export]
52#[doc(hidden)]
53macro_rules! t_alloc {
54    ($b:tt, $t:ty, $a:ident) => {
55        $b<$t>
56    };
57}
58
59#[cfg(feature = "allocator_api")]
60#[macro_export]
61#[doc(hidden)]
62macro_rules! t_alloc {
63    ($b:tt, $t:ty, $a:ident) => {
64        $b<$t, $a>
65    };
66}
compio_buf/lib.rs

compio_buf/
lib.rs
