Skip to main content

ModuleGraph

Struct ModuleGraph 

Source
pub struct ModuleGraph {
    pub schema_version: u32,
    pub root_id: ModuleId,
    pub modules: Vec<ModuleNode>,
    pub canonical_hash: ModuleGraphHash,
}
Expand description

The compiled module graph.

Fields§

§schema_version: u32

Bumped on every breaking change to the IR shape. Today: 1.

§root_id: ModuleId

Always 0 — root module interned first (BFS from the entrypoint).

§modules: Vec<ModuleNode>

Dense module table indexed by ModuleId as usize.

§canonical_hash: ModuleGraphHash

BLAKE3 of the rkyv archive bytes. Populated by ModuleGraph::archive_and_hash.

Implementations§

Source§

impl ModuleGraph

Source

pub fn new() -> Self

Allocate an empty graph. Builders use Self::push_module + Self::set_root to populate.

Source

pub fn push_module(&mut self, node: ModuleNode) -> ModuleId

Add a module; return its assigned id. First module pushed gets id 0 (the root by convention; callers should ensure that’s the entrypoint module).

Source

pub fn set_root(&mut self, id: ModuleId)

Set which module id is the root. Defaults to 0; override only if the build order put the root elsewhere.

Source

pub fn from_ast_graphs( modules: &[(String, AstGraph)], ) -> Result<Self, ModuleGraphError>

Build a ModuleGraph from a slice of (label, AstGraph) pairs. The first pair becomes the root.

Each module is run through crate::module_compiler::compile_module to extract its typed surface (option declarations, config setters with slice metadata, import edges). Caller-order is preserved — full BFS-from-root topological discovery + import-target resolution lands when import paths get typed in a follow-up ship (today, ImportEdge::target is the u32::MAX sentinel for unresolved edges).

§Errors
  • ModuleGraphError::Archive on rkyv failure during subsequent archive_and_hash calls.
  • Module-compiler errors are surfaced as ModuleGraphError variants — a module with an unrecognizable root shape causes the whole build to fail rather than silently emit a partial graph (operators should see the offending file).
Source

pub fn archive_and_hash(self) -> Result<(Self, Vec<u8>), ModuleGraphError>

Two-pass archive: serialize → BLAKE3 the bytes → stamp hash → serialize again. Mirrors LockfileGraph::archive_and_hash and AstGraph::archive_and_hash.

§Errors

ModuleGraphError::Archive on rkyv failure.

Trait Implementations§

Source§

impl Archive for ModuleGraph

Source§

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize. Read more
Source§

type Archived = ArchivedModuleGraph

The archived representation of this type. Read more
Source§

type Resolver = ModuleGraphResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.
Source§

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output. Read more
Source§

impl Clone for ModuleGraph

Source§

fn clone(&self) -> ModuleGraph

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 ModuleGraph

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ModuleGraph

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ModuleGraph

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<__D: Fallible + ?Sized> Deserialize<ModuleGraph, __D> for Archived<ModuleGraph>

Source§

fn deserialize( &self, deserializer: &mut __D, ) -> Result<ModuleGraph, <__D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl PartialEq for ModuleGraph

Source§

fn eq(&self, other: &ModuleGraph) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for ModuleGraph

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<__S: Fallible + ?Sized> Serialize<__S> for ModuleGraph

Source§

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.
Source§

impl StructuralPartialEq for ModuleGraph

Source§

impl TataraDomain for ModuleGraph

Source§

const KEYWORD: &'static str = "defmodule-graph"

The Lisp keyword (e.g., "defmonitor").
Source§

fn compile_from_args(args: &[Sexp]) -> Result<Self>

Parse the argument list (everything after the keyword) into Self.
Source§

fn compile_from_sexp(form: &Sexp) -> Result<Self, LispError>

Parse a complete form; validates the head symbol matches KEYWORD.

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> ArchiveUnsized for T
where T: Archive,

Source§

type Archived = <T as Archive>::Archived

The archived counterpart of this type. Unlike Archive, it may be unsized. Read more
Source§

fn archived_metadata( &self, ) -> <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata

Creates the archived version of the metadata for this value.
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SerializeUnsized<S> for T
where T: Serialize<S>, S: Fallible + Writer + ?Sized,

Source§

fn serialize_unsized( &self, serializer: &mut S, ) -> Result<usize, <S as Fallible>::Error>

Writes the object and returns the position of the archived type.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.