Struct moore_svlog::ty::UnpackedType

pub struct UnpackedType<'a> {
    pub core: UnpackedCore<'a>,
    pub dims: Vec<UnpackedDim<'a>>,
    // some fields omitted
}

An unpacked type.

Fields

core: UnpackedCore<'a>

The core unpacked type.

dims: Vec<UnpackedDim<'a>>

The unpacked dimensions.

Implementations

impl<'a> UnpackedType<'a>

pub fn new(core: impl Into<UnpackedCore<'a>>) -> Self

Create a new type with no unpacked dimensions.

This creates the type on the stack. In general you will want to use the make_* functions to create a type that is interned into a context.

pub fn with_dims(
    core: impl Into<UnpackedCore<'a>>,
    dims: Vec<UnpackedDim<'a>>
) -> Self

Create a new type with unpacked dimensions.

This creates the type on the stack. In general you will want to use the make_* functions to create a type that is interned into a context.

pub fn make(
    cx: &impl TypeContext<'a>,
    core: impl Into<UnpackedCore<'a>>
) -> &'a Self

Create an interned type with no unpacked dimensions.

pub fn make_dims(
    cx: &impl TypeContext<'a>,
    core: impl Into<UnpackedCore<'a>>,
    dims: Vec<UnpackedDim<'a>>
) -> &'a Self

Create an interned type with unpacked dimensions.

pub fn make_error() -> &'a Self

Create a tombstone.

pub fn make_void() -> &'a Self

Create a void type.

pub fn make_logic() -> &'a Self

Create a logic type.

pub fn make_time() -> &'a Self

Create a time type.

pub fn intern(self, cx: &impl TypeContext<'a>) -> &'a Self

Internalize this type in a context and resolve it.

pub fn resolve(&self) -> &Self

Resolve one level of name or type reference indirection.

For example, given typedef int foo; typedef foo bar;, resolves bar to foo.

pub fn resolve_full(&self) -> &Self

Resolve all name or type reference indirections recursively.

For example, given typedef int foo; typedef foo bar;, resolves bar to int.

pub fn is_error(&self) -> bool

Check if this is a tombstone.

pub fn is_identical(&self, other: &Self) -> bool

Check if this type is equal to another one.

Types which coalesce to iN in LLHD are checked for equality of their SBVT.

pub fn is_strictly_identical(&self, other: &Self) -> bool

Check if this type is strictly equal to another one.

pub fn is_packed(&self) -> bool

Check if this type is strictly a packed type.

pub fn get_packed(&self) -> Option<&'a PackedType<'a>>

If this type is strictly a packed type, convert it.

pub fn domain(&self) -> Domain

Get the domain for this type.

pub fn sign(&self) -> Sign

Get the sign for this type.

pub fn get_bit_size(&self) -> Option<usize>

Compute the size of this type in bits.

Returns None if one of the type’s dimensions is unsized, associative, or a queue, or the core type has no known size.

pub fn is_simple_bit_vector(&self) -> bool

Check if this type is trivially a SBVT.

pub fn is_integer_atom(&self) -> bool

Check if this type is an integer atom type, like int.

pub fn is_single_bit(&self) -> bool

Check if this type is a single bit type, like bit.

pub fn is_string(&self) -> bool

Check if this type is a string, like string.

pub fn coalesces_to_llhd_scalar(&self) -> bool

Check if this type will coalesce to a scalar type in LLHD, like i42.

pub fn get_simple_bit_vector(&self) -> Option<SbvType>

Convert this type into an SBVT if possible.

pub fn simple_bit_vector(&self, cx: &impl DiagEmitter, span: Span) -> SbvType

Convert this type into an SBVT, or report a bug with the given span.

pub fn packed_dims(&self) -> impl Iterator<Item = PackedDim> + 'a

Get an iterator over the type’s packed dimensions, slowest-varying first.

For example, produces [3:0], [7:0] for bit [3:0][7:0] $ [1][2].

pub fn unpacked_dims<'s>(&'s self) -> impl Iterator<Item = UnpackedDim<'a>> + 's

Get an iterator over the type’s unpacked dimensions, slowest-varying first.

For example, produces [1], [2] for bit [3:0][7:0] $ [1][2].

pub fn dims<'s>(&'s self) -> impl Iterator<Item = Dim<'a>> + 's

Get an iterator over the type’s dimensions. slowest-varying first.

For example, produces [1], [2], [3:0], [7:0] for bit [3:0][7:0] $ [1][2].

pub fn pop_dim(&self, cx: &impl TypeContext<'a>) -> Option<&'a Self>

Pop the outermost dimension off the type.

For example, maps bit $ [1][2] to bit $ [2]. Pops off the packed type as well, mapping bit [7:0] $ to bit $.

pub fn replace_dim(&self, cx: &impl TypeContext<'a>, dim: Dim<'a>) -> &'a Self

Replace the outermost dimension of the type.

Panics if the type has no dimensions, or a packed dimension is replaced with an unpacked dimension, or vice-versa.

pub fn outermost_dim(&self) -> Option<Dim<'a>>

Get the outermost dimension of the type.

For example, yields the [1] in bit $ [1][2].

pub fn get_struct(&self) -> Option<&StructType<'a>>

Get the underlying struct, or None if the type is no struct.

pub fn get_enum(&self) -> Option<&EnumType<'a>>

Get the underlying enum, or None if the type is no enum.

pub fn get_module(&self) -> Option<&ModuleType<'a>>

Get the underlying module, or None if the type is not a module.

pub fn get_interface(&self) -> Option<&InterfaceType<'a>>

Get the underlying interface, or None if the type is not a interface.

Trait Implementations

impl<'a> Clone for UnpackedType<'a>

fn clone(&self) -> UnpackedType<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnpackedType<'_>

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

Formats the value using the given formatter.

impl Display for UnpackedType<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a UnpackedType<'a>> for TypeContext<'a>

fn from(ty: &'a UnpackedType<'a>) -> Self

Performs the conversion.

impl<'a> From<&'a UnpackedType<'a>> for CastType<'a>

fn from(ty: &'a UnpackedType<'a>) -> CastType<'a>

Performs the conversion.

impl Hash for UnpackedType<'_>

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<UnpackedType<'_>> for UnpackedType<'_>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> WalkVisitor<'a> for UnpackedType<'a>

fn walk(&'a self, _visitor: &mut dyn Visitor<'a>)

Walk a visitor over self.

impl Eq for UnpackedType<'_>