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

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

use crate::{FromVpiHandle, RawHandle, StoreIntoVpiHandle};

#[derive(Clone)]
///Vpi handle type to interact with verilog values
pub struct Handle<E>
where
    E: FromVpiHandle,
{
    pub(crate) handle: crate::RawHandle,
    pd: core::marker::PhantomData<E>,
}

impl<E> Handle<E>
where
    E: FromVpiHandle,
{
    /// Immutable borrow of wrapped value
    pub fn borrow(&self) -> crate::Result<HandleRef<'_, E>> {
        Ok(HandleRef(Default::default(), self.get_value()?))
    }

    /// Mutable borrow of wrapped value
    pub fn borrow_mut(&mut self) -> crate::Result<HandleMut<'_, E>>
    where
        E: StoreIntoVpiHandle,
    {
        Ok(HandleMut(self, self.get_value()?))
    }

    /// Obtain underling raw handle
    pub fn raw_handle(&self) -> RawHandle {
        self.handle
    }

    /// Consumes the [Handle], returning the wrapped value.
    pub fn get_value(&self) -> crate::Result<E> {
        unsafe { E::from_vpi_handle(self.handle) }
    }

    /// Get verilog name of handle
    pub fn raw_name(&self) -> *const core::ffi::c_char {
        unsafe { vpi_user::vpi_get_str(vpi_user::vpiName as i32, self.handle.as_ptr()) }
    }

    /// Get verilog name of handle
    pub fn name(&self) -> crate::Result<alloc::string::String> {
        use crate::alloc::string::ToString;

        unsafe { CStr::from_ptr(self.raw_name()) }
            .to_str()
            .map(|e| e.to_string())
            .map_err(crate::VpiError::Utf8Error)
    }
}

pub struct HandleRef<'a, E>(core::marker::PhantomData<&'a ()>, E)
where
    E: FromVpiHandle;

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

pub struct HandleMut<'a, E>(&'a mut Handle<E>, E)
where
    E: FromVpiHandle + StoreIntoVpiHandle;

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

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

impl<E> Drop for HandleMut<'_, E>
where
    E: FromVpiHandle + StoreIntoVpiHandle,
{
    fn drop(&mut self) {
        unsafe { StoreIntoVpiHandle::store_into_vpi_handle(&self.1, self.0.handle) }.unwrap();
    }
}

impl<E> crate::__private::Sealed for Handle<E> where E: FromVpiHandle {}

impl<E> FromVpiHandle for Handle<E>
where
    E: FromVpiHandle,
{
    unsafe fn from_vpi_handle(handle: RawHandle) -> crate::Result<Self> {
        Ok(Self {
            handle,
            pd: Default::default(),
        })
    }
}