ino 0.0.3

I/O traits more general than std::io.
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

/*
 * Description: Vectored I/O traits and structs.
 *
 * Copyright (C) 2025 d@nny mc² <dmc2@amass.energy>
 * SPDX-License-Identifier: AGPL-3.0-or-later
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#![cfg(all(unix, feature = "std-io"))]

//! Vectored I/O traits and structs.

use std::{marker::PhantomData, mem, slice};

use libc;

use super::BufError;


pub struct IoSlice<'data> {
  vec: libc::iovec,
  _ph: PhantomData<&'data [u8]>,
}

impl<'data> IoSlice<'data> {
  #[inline(always)]
  pub const fn new(buf: &'data [u8]) -> Self {
    Self {
      vec: libc::iovec {
        iov_base: buf.as_ptr() as *mut u8 as *mut libc::c_void,
        iov_len: buf.len(),
      },
      _ph: PhantomData,
    }
  }

  #[inline]
  pub fn advance(&mut self, n: usize) {
    if self.vec.iov_len < n {
      panic!("advancing IoSlice beyond its length");
    }
    unsafe {
      self.vec.iov_len -= n;
      self.vec.iov_base = self.vec.iov_base.add(n);
    }
  }

  #[inline(always)]
  pub const fn as_slice(&self) -> &'data [u8] {
    unsafe { slice::from_raw_parts(self.vec.iov_base as *mut u8, self.vec.iov_len) }
  }
}

pub trait WriteVecData {
  type E: BufError;
  fn write_vectored_data<'data>(
    &mut self,
    data: &'data [IoSlice<'data>],
  ) -> (usize, Option<Self::E>);
}

pub struct IoSliceMut<'buf> {
  vec: libc::iovec,
  _ph: PhantomData<&'buf mut [mem::MaybeUninit<u8>]>,
}

impl<'buf> IoSliceMut<'buf> {
  #[inline(always)]
  pub const fn new(buf: &'buf mut [u8]) -> Self {
    Self {
      vec: libc::iovec {
        iov_base: buf.as_mut_ptr() as *mut libc::c_void,
        iov_len: buf.len(),
      },
      _ph: PhantomData,
    }
  }

  #[inline]
  pub fn advance(&mut self, n: usize) {
    if self.vec.iov_len < n {
      panic!("advancing IoSliceMut beyond its length");
    }
    unsafe {
      self.vec.iov_len -= n;
      self.vec.iov_base = self.vec.iov_base.add(n);
    }
  }

  #[inline(always)]
  pub const fn as_slice(&self) -> &[mem::MaybeUninit<u8>] {
    unsafe {
      slice::from_raw_parts(
        self.vec.iov_base as *mut mem::MaybeUninit<u8>,
        self.vec.iov_len,
      )
    }
  }

  #[inline(always)]
  pub const fn into_slice(self) -> &'buf mut [mem::MaybeUninit<u8>] {
    unsafe {
      slice::from_raw_parts_mut(
        self.vec.iov_base as *mut mem::MaybeUninit<u8>,
        self.vec.iov_len,
      )
    }
  }

  #[inline(always)]
  pub const fn as_mut_slice(&mut self) -> &mut [mem::MaybeUninit<u8>] {
    unsafe {
      slice::from_raw_parts_mut(
        self.vec.iov_base as *mut mem::MaybeUninit<u8>,
        self.vec.iov_len,
      )
    }
  }
}

pub trait ReadVecBuf {
  type E: BufError;
  fn read_vectored_buf<'buf>(
    &mut self,
    buf: &'buf mut [IoSliceMut<'buf>],
  ) -> (usize, Option<Self::E>);
}