vpi_export 0.1.10

Export Rust function to be used on a verilog module through VPI
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

use crate::RawHandle;

///Wrapper to a vpi handle generated by [crate::vpi_user::vpi_iterate].
pub struct VpiIter(Option<RawHandle>);

impl VpiIter {
    ///Equivalend to [crate::vpi_user::vpi_iterate], returning a wrapped value.
    /// # Safety
    /// `t` must be valid and `handle` must be valid, not dangling or null
    pub unsafe fn new(t: crate::vpi_user::PLI_INT32, handle: crate::vpi_user::vpiHandle) -> Self {
        let args_iter = crate::vpi_user::vpi_iterate(t, handle);
        Self(RawHandle::new(args_iter))
    }
}

impl Iterator for VpiIter {
    type Item = crate::RawHandle;

    fn next(&mut self) -> Option<Self::Item> {
        //Safety: proper use of function
        crate::RawHandle::new(unsafe { crate::vpi_user::vpi_scan(self.0?.as_ptr()) })
    }
}

impl Drop for VpiIter {
    fn drop(&mut self) {
        if let Some(p) = self.0 {
            unsafe { crate::vpi_user::vpi_free_object(p.as_ptr()) };
        }
    }
}