flatipc 0.1.2

Zerocopy IPC between Xous clients and servers
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153

use std::mem::MaybeUninit;

pub struct Vec<T, const N: usize> {
    length: usize,
    buffer: [MaybeUninit<T>; N],
}

unsafe impl<T, const N: usize> crate::IpcSafe for Vec<T, N> {}

impl<T, const N: usize> Vec<T, N> {
    pub fn new() -> Self {
        let buffer = [const { MaybeUninit::uninit() }; N];
        Vec { buffer, length: 0 }
    }

    pub fn push(&mut self, value: T) {
        if self.length < N {
            self.buffer[self.length] = MaybeUninit::new(value);
            self.length += 1;
        }
    }

    pub fn pop(&mut self) -> Option<T> {
        assert!(self.length <= self.buffer.len());
        if self.length > 0 {
            self.length -= 1;
            unsafe { Some(self.buffer[self.length].as_ptr().read()) }
        } else {
            None
        }
    }

    pub fn len(&self) -> usize {
        assert!(self.length <= self.buffer.len());
        self.length
    }

    pub fn as_slice(&self) -> &[T] {
        assert!(self.length <= self.buffer.len());
        unsafe { core::slice::from_raw_parts(self.buffer.as_ptr() as *const T, self.length) }
    }

    pub fn as_mut_slice(&mut self) -> &mut [T] {
        assert!(self.length <= self.buffer.len());
        unsafe { core::slice::from_raw_parts_mut(self.buffer.as_mut_ptr() as *mut T, self.length) }
    }

    pub fn clear(&mut self) {
        assert!(self.length <= self.buffer.len());
        for i in 0..self.length {
            unsafe {
                core::ptr::drop_in_place(&mut self.buffer[i]);
            }
        }
        self.length = 0;
    }

    pub fn iter(&self) -> core::slice::Iter<'_, T> { self.as_slice().iter() }

    pub fn iter_mut(&mut self) -> core::slice::IterMut<'_, T> { self.as_mut_slice().iter_mut() }

    pub fn resize(&mut self, new_len: usize, value: T)
    where
        T: Clone,
    {
        assert!(self.length <= self.buffer.len());
        if new_len > self.length {
            for _ in self.length..new_len {
                self.push(value.clone());
            }
        } else {
            self.length = new_len;
        }
    }
}

impl<T, const N: usize> Drop for Vec<T, N> {
    fn drop(&mut self) { self.clear(); }
}

impl<T, const N: usize> core::fmt::Debug for Vec<T, N>
where
    T: core::fmt::Debug,
{
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_list().entries(self.iter()).finish()
    }
}

impl<T, const N: usize> Default for Vec<T, N> {
    fn default() -> Self { Vec::new() }
}

impl<T, const N: usize> core::ops::Deref for Vec<T, N> {
    type Target = [T];

    fn deref(&self) -> &Self::Target { self.as_slice() }
}

impl<T, const N: usize> core::ops::DerefMut for Vec<T, N> {
    fn deref_mut(&mut self) -> &mut Self::Target { self.as_mut_slice() }
}

impl<T, const N: usize> From<&[T]> for Vec<T, N>
where
    T: Clone,
{
    fn from(value: &[T]) -> Self {
        let mut vec = Vec::new();
        for item in value {
            vec.push(item.clone());
        }
        vec
    }
}

impl<T, const N: usize> From<&mut [T]> for Vec<T, N>
where
    T: Clone,
{
    fn from(value: &mut [T]) -> Self {
        let mut vec = Vec::new();
        for item in value {
            vec.push(item.clone());
        }
        vec
    }
}

impl<T, const N: usize> core::fmt::Display for Vec<T, N>
where
    T: core::fmt::Display,
{
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        for (i, item) in self.iter().enumerate() {
            if i > 0 {
                write!(f, ", ")?;
            }
            write!(f, "{}", item)?;
        }
        Ok(())
    }
}

impl<T, const N: usize> core::ops::Index<usize> for Vec<T, N> {
    type Output = T;

    fn index(&self, index: usize) -> &Self::Output { &self.as_slice()[index] }
}

impl<T, const N: usize> core::ops::IndexMut<usize> for Vec<T, N> {
    fn index_mut(&mut self, index: usize) -> &mut Self::Output { &mut self.as_mut_slice()[index] }
}