circt::firrtl::FIRVersion Struct Reference

The FIRRTL specification version. More...

#include <FIRParser.h>

Collaboration diagram for circt::firrtl::FIRVersion:

Public Member Functions
constexpr	FIRVersion (uint16_t major, uint16_t minor, uint16_t patch)
constexpr	operator uint64_t () const
constexpr bool	operator< (FIRVersion rhs) const
constexpr bool	operator> (FIRVersion rhs) const
constexpr bool	operator<= (FIRVersion rhs) const
constexpr bool	operator>= (FIRVersion rhs) const

Static Public Member Functions
static std::optional< FIRVersion >	fromString (StringRef str)
	Parse a version string of the form "major.minor.patch".

Public Attributes
uint16_t	major
uint16_t	minor
uint16_t	patch

Detailed Description

The FIRRTL specification version.

Definition at line 89 of file FIRParser.h.

Constructor & Destructor Documentation

FIRVersion()

circt::firrtl::FIRVersion::FIRVersion ( uint16_t major, uint16_t minor, uint16_t patch )

inlineconstexpr

Definition at line 90 of file FIRParser.h.

References major, minor, and patch.

Referenced by fromString(), operator<(), operator<=(), operator>(), and operator>=().

Member Function Documentation

fromString()

std::optional< FIRVersion > circt::firrtl::FIRVersion::fromString ( StringRef str )

inlinestatic

Parse a version string of the form "major.minor.patch".

Returns std::nullopt if the string is malformed or values overflow uint16_t.

Definition at line 115 of file FIRParser.h.

References FIRVersion(), major, minor, and patch.

Referenced by circt::firrtl::registerToFIRFileTranslation().

operator uint64_t()

circt::firrtl::FIRVersion::operator uint64_t ( ) const

inlineexplicitconstexpr

Definition at line 93 of file FIRParser.h.

References major, minor, and patch.

operator<()

bool circt::firrtl::FIRVersion::operator< ( FIRVersion rhs ) const

inlineconstexpr

Definition at line 97 of file FIRParser.h.

References FIRVersion().

operator<=()

bool circt::firrtl::FIRVersion::operator<= ( FIRVersion rhs ) const

inlineconstexpr

Definition at line 105 of file FIRParser.h.

References FIRVersion().

operator>()

bool circt::firrtl::FIRVersion::operator> ( FIRVersion rhs ) const

inlineconstexpr

Definition at line 101 of file FIRParser.h.

References FIRVersion().

operator>=()

bool circt::firrtl::FIRVersion::operator>= ( FIRVersion rhs ) const

inlineconstexpr

Definition at line 109 of file FIRParser.h.

References FIRVersion().

Member Data Documentation

major

uint16_t circt::firrtl::FIRVersion::major

Definition at line 124 of file FIRParser.h.

Referenced by FIRVersion(), fromString(), operator uint64_t(), and circt::firrtl::operator<<().

minor

uint16_t circt::firrtl::FIRVersion::minor

Definition at line 125 of file FIRParser.h.

Referenced by FIRVersion(), fromString(), operator uint64_t(), and circt::firrtl::operator<<().

patch

uint16_t circt::firrtl::FIRVersion::patch

Definition at line 126 of file FIRParser.h.

Referenced by FIRVersion(), fromString(), operator uint64_t(), and circt::firrtl::operator<<().

---

The documentation for this struct was generated from the following file:

• /home/runner/work/circt-www/circt-www/circt_src/include/circt/Dialect/FIRRTL/FIRParser.h