esi::VoidType Class Reference

The "void" type is a special type which can be used to represent no type. More...

#include <Types.h>

Inheritance diagram for esi::VoidType:

Collaboration diagram for esi::VoidType:

Public Member Functions
	VoidType (const ID &id)
std::ptrdiff_t	getBitWidth () const override
void	ensureValid (const std::any &obj) const override
	Ensure that a std::any object is valid for this type.
MutableBitVector	serialize (const std::any &obj) const override
	Serialize an object to a MutableBitVector (LSB-first stream).
std::any	deserialize (BitVector &data) const override
	Deserialize from a BitVector stream (LSB-first).
std::any	deserialize (const MessageData &data) const
Public Member Functions inherited from esi::Type
	Type (const ID &id)
virtual	~Type ()=default
ID	getID () const
void	setHWBitwidth (std::ptrdiff_t bw)
	Set from manifest JSON hwBitwidth.
std::any	deserialize (const MessageData &data) const
std::optional< std::string >	isValid (const std::any &obj) const
void	dump (std::ostream &os, bool oneLine=false) const
std::string	toString (bool oneLine=false) const

Additional Inherited Members
Public Types inherited from esi::Type
using	ID = std::string
Protected Attributes inherited from esi::Type
ID	id
std::ptrdiff_t	hwBitwidth = -1

Detailed Description

The "void" type is a special type which can be used to represent no type.

Definition at line 141 of file Types.h.

Constructor & Destructor Documentation

VoidType()

esi::VoidType::VoidType ( const ID & id )

inline

Definition at line 144 of file Types.h.

References esi::Type::id, and esi::Type::Type().

Member Function Documentation

deserialize() [1/2]

std::any esi::VoidType::deserialize ( BitVector & data ) const

overridevirtual

Deserialize from a BitVector stream (LSB-first).

Implementations consume bits from 'data' in-place (via logical right shifts) and return the reconstructed value. Remaining bits stay in 'data'.

Reimplemented from esi::Type.

Definition at line 163 of file Types.cpp.

deserialize() [2/2]

std::any esi::Type::deserialize ( const MessageData & data ) const

inline

Definition at line 67 of file Types.h.

ensureValid()

void esi::VoidType::ensureValid ( const std::any & obj ) const

overridevirtual

Ensure that a std::any object is valid for this type.

Throws std::runtime_error if the object is not valid.

Reimplemented from esi::Type.

Definition at line 147 of file Types.cpp.

Referenced by serialize().

getBitWidth()

std::ptrdiff_t esi::VoidType::getBitWidth ( ) const

inlineoverridevirtual

Reimplemented from esi::Type.

Definition at line 148 of file Types.h.

serialize()

MutableBitVector esi::VoidType::serialize ( const std::any & obj ) const

overridevirtual

Serialize an object to a MutableBitVector (LSB-first stream).

The object should be passed via std::any. Implementations append fields in the order they are iterated (the first serialized field occupies the least-significant bits of the result).

Reimplemented from esi::Type.

Definition at line 170 of file Types.cpp.

References ensureValid().

---

The documentation for this class was generated from the following files:

• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/include/esi/Types.h
• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/lib/Types.cpp