Struct Record

pub struct Record<'a> { /* private fields */ }

An immutable reference to a TableGen record.

This reference cannot outlive the RecordKeeper from which it is borrowed.

Implementations

impl<'a> Record<'a>

pub unsafe fn from_raw(ptr: TableGenRecordRef) -> Record<'a>

Creates a record from a raw object.

Safety

The raw object must be valid.

pub fn name(self) -> Result<&'a str, Error>

Returns the name of the record.

Errors

Returns an error if the name is not a valid UTF-8 string.

pub fn bit_value(self, name: &str) -> Result<bool, Error>

Returns the boolean value of the field with the given name if this field is of type BitInit.

pub fn bits_value(self, name: &str) -> Result<Vec<bool>, Error>

Returns the field with the given name converted to a Vec<bool> if this field is of type BitsInit.

pub fn int_value(self, name: &str) -> Result<i64, Error>

Returns the integer value of the field with the given name if this field is of type IntInit.

pub fn code_value(self, name: &str) -> Result<String, Error>

Returns the field with the given name converted to a String if this field is of type StringInit.

Note that this copies the string into a new string.

pub fn code_str_value(self, name: &str) -> Result<&'a str, Error>

Returns the field with the given name converted to a &str if this field is of type StringInit.

pub fn string_value(self, name: &str) -> Result<String, Error>

Returns the field with the given name converted to a String if this field is of type StringInit.

Note that this copies the string into a new string.

pub fn str_value(self, name: &str) -> Result<&'a str, Error>

Returns the field with the given name converted to a &str if this field is of type StringInit.

pub fn def_value(self, name: &str) -> Result<Record<'a>, Error>

Returns the field with the given name converted to a Record if this field is of type DefInit.

pub fn list_value(self, name: &str) -> Result<ListInit<'a>, Error>

Returns the field with the given name converted to a ListInit if this field is of type ListInit.

pub fn dag_value(self, name: &str) -> Result<DagInit<'a>, Error>

Returns the field with the given name converted to a DagInit if this field is of type DagInit.

pub fn value<'n>(self, name: &'n str) -> Result<RecordValue<'a>, Error>

Returns a RecordValue for the field with the given name.

pub fn anonymous(self) -> bool

Returns true if the record is anonymous.

pub fn subclass_of(self, class: &str) -> bool

Returns true if the record is a subclass of the class with the given name.

pub fn values(self) -> RecordValueIter<'a>

Returns an iterator over the fields of the record.

The iterator yields RecordValue structs

Trait Implementations

impl<'a> Clone for Record<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Record<'_>

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

Formats the value using the given formatter.

impl Display for Record<'_>

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

Formats the value using the given formatter.

impl<'a> From<DefInit<'a>> for Record<'a>

fn from(value: DefInit<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Record<'a>

fn eq(&self, other: &Record<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SourceLoc for Record<'_>

fn source_location(self) -> SourceLocation

Returns the source location.

impl<'a> TryFrom<RecordValue<'a>> for Record<'a>

type Error = SourceError<TableGenError>

The type returned in the event of a conversion error.

fn try_from(record_value: RecordValue<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<TypedInit<'a>> for Record<'a>

type Error = SourceError<TableGenError>

The type returned in the event of a conversion error.

fn try_from(value: TypedInit<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Copy for Record<'a>

impl<'a> Eq for Record<'a>

impl<'a> StructuralPartialEq for Record<'a>