rustix 1.1.3

Safe Rust bindings to POSIX/Unix/Linux/Winsock-like syscalls
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

//! The following is derived from Rust's
//! library/std/src/sys/unix/io.rs
//! dca3f1b786efd27be3b325ed1e01e247aa589c3b.
//!
//! All code in this file is licensed MIT or Apache 2.0 at your option.

#![allow(unsafe_code)]
use crate::backend::c;
#[cfg(not(linux_raw))]
use c::size_t as __kernel_size_t;
use core::marker::PhantomData;
use core::slice;
#[cfg(linux_raw)]
use linux_raw_sys::general::__kernel_size_t;

/// <https://doc.rust-lang.org/stable/std/io/struct.IoSlice.html>
#[derive(Copy, Clone)]
#[repr(transparent)]
pub struct IoSlice<'a> {
    vec: c::iovec,
    _p: PhantomData<&'a [u8]>,
}

impl<'a> IoSlice<'a> {
    /// <https://doc.rust-lang.org/stable/std/io/struct.IoSlice.html#method.new>
    #[inline]
    pub fn new(buf: &'a [u8]) -> IoSlice<'a> {
        IoSlice {
            vec: c::iovec {
                iov_base: buf.as_ptr() as *mut u8 as *mut c::c_void,
                iov_len: buf.len() as _,
            },
            _p: PhantomData,
        }
    }

    /// <https://doc.rust-lang.org/stable/std/io/struct.IoSlice.html#method.advance>
    #[inline]
    pub fn advance(&mut self, n: usize) {
        if self.vec.iov_len < n as _ {
            panic!("advancing IoSlice beyond its length");
        }

        unsafe {
            // `__kernel_size_t` will always have the same size as `usize`, but it is a `u32` on
            // 32-bit platforms and `u64` on 64-bit platforms when using `linux_raw` backend
            self.vec.iov_len -= n as __kernel_size_t;
            self.vec.iov_base = self.vec.iov_base.add(n);
        }
    }

    /// <https://doc.rust-lang.org/stable/std/io/struct.IoSlice.html#method.as_slice>
    #[inline]
    pub fn as_slice(&self) -> &[u8] {
        unsafe { slice::from_raw_parts(self.vec.iov_base as *mut u8, self.vec.iov_len as usize) }
    }
}

/// <https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html>
#[repr(transparent)]
pub struct IoSliceMut<'a> {
    vec: c::iovec,
    _p: PhantomData<&'a mut [u8]>,
}

impl<'a> IoSliceMut<'a> {
    /// <https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html#method.new>
    #[inline]
    pub fn new(buf: &'a mut [u8]) -> IoSliceMut<'a> {
        IoSliceMut {
            vec: c::iovec {
                iov_base: buf.as_mut_ptr() as *mut c::c_void,
                iov_len: buf.len() as _,
            },
            _p: PhantomData,
        }
    }

    /// <https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html#method.advance>
    #[inline]
    pub fn advance(&mut self, n: usize) {
        if self.vec.iov_len < n as _ {
            panic!("advancing IoSliceMut beyond its length");
        }

        unsafe {
            // `__kernel_size_t` will always have the same size as `usize`, but it is a `u32` on
            // 32-bit platforms and `u64` on 64-bit platforms when using `linux_raw` backend
            self.vec.iov_len -= n as __kernel_size_t;
            self.vec.iov_base = self.vec.iov_base.add(n);
        }
    }

    /// <https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html#method.as_slice>
    #[inline]
    pub fn as_slice(&self) -> &[u8] {
        unsafe { slice::from_raw_parts(self.vec.iov_base as *mut u8, self.vec.iov_len as usize) }
    }

    /// <https://doc.rust-lang.org/stable/std/io/struct.IoSliceMut.html#method.as_slice_mut>
    #[inline]
    pub fn as_mut_slice(&mut self) -> &mut [u8] {
        unsafe {
            slice::from_raw_parts_mut(self.vec.iov_base as *mut u8, self.vec.iov_len as usize)
        }
    }
}