esi::StructType Class Reference

Structs are an ordered collection of fields, each with a name and a type. More...

#include <Types.h>

Inheritance diagram for esi::StructType:

Collaboration diagram for esi::StructType:

Public Types
using	FieldVector = std::vector< std::pair< std::string, const Type * > >
Public Types inherited from esi::Type
using	ID = std::string

Public Member Functions
	StructType (const ID &id, const FieldVector &fields, bool reverse=true)
const FieldVector &	getFields () const
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.
MessageData	serialize (const std::any &obj) const override
	Serialize an object to MessageData.
std::pair< std::any, std::span< const uint8_t > >	deserialize (std::span< const uint8_t > data) const override
	Deserialize from a span of bytes to an object.
bool	isReverse () const
Public Member Functions inherited from esi::Type
	Type (const ID &id)
virtual	~Type ()=default
ID	getID () const
std::optional< std::string >	isValid (const std::any &obj) const

Private Attributes
FieldVector	fields
bool	reverse

Additional Inherited Members
Protected Attributes inherited from esi::Type
ID	id

Detailed Description

Structs are an ordered collection of fields, each with a name and a type.

Definition at line 194 of file Types.h.

Member Typedef Documentation

FieldVector

using esi::StructType::FieldVector = std::vector<std::pair<std::string, const Type *> >

Definition at line 196 of file Types.h.

Constructor & Destructor Documentation

StructType()

esi::StructType::StructType ( const ID &  id, const FieldVector &  fields, bool  reverse = true  )

inline

Definition at line 198 of file Types.h.

Member Function Documentation

deserialize()

std::pair< std::any, std::span< const uint8_t > > esi::StructType::deserialize ( std::span< const uint8_t >  data ) const

overridevirtual

Deserialize from a span of bytes to an object.

Returns the deserialized object as a std::any and a span to the remaining bytes.

Reimplemented from esi::Type.

ensureValid()

void esi::StructType::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 270 of file Types.cpp.

References fields.

Referenced by serialize().

getBitWidth()

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

inlineoverridevirtual

Reimplemented from esi::Type.

Definition at line 202 of file Types.h.

References getFields().

Referenced by serialize().

getFields()

const FieldVector & esi::StructType::getFields ( ) const

inline

Definition at line 201 of file Types.h.

References fields.

Referenced by getBitWidth().

isReverse()

bool esi::StructType::isReverse ( ) const

inline

Definition at line 223 of file Types.h.

References reverse.

Referenced by serialize().

serialize()

MessageData esi::StructType::serialize ( const std::any &  obj ) const

overridevirtual

Serialize an object to MessageData.

The object should be passed as a std::any to provide type erasure. Returns a MessageData containing the serialized representation.

Reimplemented from esi::Type.

Definition at line 302 of file Types.cpp.

References ensureValid(), fields, getBitWidth(), and isReverse().

Member Data Documentation

fields

FieldVector esi::StructType::fields

private

Definition at line 226 of file Types.h.

Referenced by esiaccel.types.StructType::bit_width(), esiaccel.types.StructType::deserialize(), ensureValid(), getFields(), esiaccel.types.StructType::is_valid(), serialize(), and esiaccel.types.StructType::serialize().

reverse

bool esi::StructType::reverse

private

Definition at line 227 of file Types.h.

Referenced by isReverse().

---

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