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
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

use core::ops::{Deref, DerefMut};

use crate::{FromVpiHandle, Result, VpiTaskArg, __private::Sealed};

/// Mark a value as `input`. Changes on this argument will have no effect on
/// the task. This is equivalent as using the argument `E`
#[repr(transparent)]
pub struct Input<'a, E>(E, core::marker::PhantomData<&'a ()>)
where
    E: FromVpiHandle;

impl<E> Deref for Input<'_, E>
where
    E: FromVpiHandle,
{
    type Target = E;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<E> DerefMut for Input<'_, E>
where
    E: FromVpiHandle,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<E> Input<'_, E>
where
    E: FromVpiHandle,
{
    /// Into inner data
    pub fn into_inner(self) -> E {
        self.0
    }
}

impl<E> Sealed for Input<'_, E> where E: FromVpiHandle {}

impl<'a, E> VpiTaskArg<'a> for Input<'a, E>
where
    E: FromVpiHandle,
{
    type Data = Option<E>;
    unsafe fn initialize_data(handle: vpi_user::vpiHandle) -> Result<Self::Data> {
        Ok(Some(E::from_vpi_handle(handle)?))
    }

    fn new(e: &mut Self::Data) -> Self {
        Self(core::mem::take(e).unwrap(), Default::default())
    }

    unsafe fn finalize_data(_: Self::Data, _: vpi_user::vpiHandle) -> Result<()> {
        //do nothing
        Ok(())
    }
}