Skip to main content

IrModule

Struct IrModule 

Source
#[non_exhaustive]
pub struct IrModule { pub header: IrHeader, pub strings: StringTable, pub slots: SlotTable, pub opcodes: Vec<u8>, pub islands: IslandTableParsed, /* private fields */ }
Expand description

A fully parsed and validated IR module, ready for walking.

Marked #[non_exhaustive]: the module carries derived lookup indices that must stay in sync with the tables, so it can only be built by parse.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§header: IrHeader

Parsed 16-byte file header.

§strings: StringTable

The module’s string table — every name, literal and attribute value.

§slots: SlotTable

The module’s slot declarations, including their defaults.

§opcodes: Vec<u8>

Raw opcode stream; the walker interprets it on the fly.

§islands: IslandTableParsed

The module’s island declarations.

Implementations§

Source§

impl IrModule

Source

pub fn parse(data: &[u8]) -> Result<Self, IrError>

Parse a complete FMIR binary into a validated IrModule.

Source

pub fn slot_entry(&self, slot_id: u16) -> Option<&SlotEntry>

Look up a slot table entry by slot_id in O(1).

Source

pub fn island_entry(&self, island_id: u16) -> Option<&IslandEntry>

Look up an island table entry by island id in O(1).

Source

pub fn validate(&self) -> Result<(), IrError>

Validate cross-table references and opcode-stream structure.

Runs once at parse time (O(n) in the bytecode length) so the walker can stay cheap and so malformed IR fails at load rather than rendering mystery HTML on some later request.

Source

pub fn slot_id_by_name(&self, name: &str) -> Option<u16>

Look up a slot ID by its name. Returns None if no slot with that name exists.

DUPLICATE-NAME RULE: slot names are not required to be unique — the compiler derives some of them per-element (text:<index>, attr:class) rather than per-module — so a name can address more than one slot. The whole crate resolves that collision the same way: the first entry in slot-table order wins, here, in crate::slot::SlotData::from_json, and in the walker’s island-props builder. They used to disagree three ways (first, last, and last-by-ascending-slot-id), so setting a value by name filled one slot and left its twin blank while the island’s props reported a third answer.

Verified by: crates/forma-ir/src/parser.rs > “duplicate_slot_names_resolve_first_wins_everywhere”

Trait Implementations§

Source§

impl Clone for IrModule

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IrModule

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more