Struct VariableMeta 

pub struct VariableMeta<VarId, ScopeId> {
    pub var: VariableRef<VarId, ScopeId>,
    pub num_bits: Option<u32>,
    pub variable_type: Option<VariableType>,
    pub variable_type_name: Option<String>,
    pub index: Option<VariableIndex>,
    pub direction: Option<VariableDirection>,
    pub enum_map: HashMap<String, String>,
    pub encoding: VariableEncoding,
}

Fields

var: VariableRef<VarId, ScopeId>

num_bits: Option<u32>

variable_type: Option<VariableType>

Type of the variable in the HDL (on a best effort basis).

variable_type_name: Option<String>

Type name of variable, if available

index: Option<VariableIndex>

direction: Option<VariableDirection>

enum_map: HashMap<String, String>

encoding: VariableEncoding

Indicates how the variable is stored. A variable of “type” boolean for example could be stored as a String or as a BitVector.

Implementations

impl<VarId1, ScopeId1> VariableMeta<VarId1, ScopeId1>

pub fn map_ids<VarId2, ScopeId2>( self, var_fn: impl FnMut(VarId1) -> VarId2, scope_fn: impl FnMut(ScopeId1) -> ScopeId2, ) -> VariableMeta<VarId2, ScopeId2>

Trait Implementations

impl<VarId: Clone, ScopeId: Clone> Clone for VariableMeta<VarId, ScopeId>

fn clone(&self) -> VariableMeta<VarId, ScopeId>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<VarId: Debug, ScopeId: Debug> Debug for VariableMeta<VarId, ScopeId>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, VarId, ScopeId> Deserialize<'de> for VariableMeta<VarId, ScopeId>

where VarId: Deserialize<'de>, ScopeId: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<VarId, ScopeId> FromBytesOwned for VariableMeta<VarId, ScopeId>

where Json<Self>: FromBytesOwned,

fn from_bytes_owned(__data: &[u8]) -> Result<Self, Error>

Decode a value from a slice of bytes, the resulting value should not borrow the input data.

impl<VarId, ScopeId> Serialize for VariableMeta<VarId, ScopeId>

where VarId: Serialize, ScopeId: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__to_bytes_a, VarId, ScopeId> ToBytes<'__to_bytes_a> for VariableMeta<VarId, ScopeId>

where for<'__to_bytes_b> Json<&'__to_bytes_b Self>: ToBytes<'__to_bytes_b>,

type Bytes = Vec<u8>

A configurable byte slice representation, allows any type that implements AsRef<[u8]>

fn to_bytes(&self) -> Result<Self::Bytes, Error>

to_bytes converts a value into Self::Bytes