Struct Interface 

pub struct Interface {
    pub module: String,
    pub types: Vec<TyDecl>,
    pub traits: Vec<TraitSig>,
    pub impls: Vec<ImplSig>,
    pub items: Vec<Item>,
}

A module’s published signature.

Fields

module: String

types: Vec<TyDecl>

Types in declaration order, so the rendered file is stable.

traits: Vec<TraitSig>

The trait declarations this module owns.

impls: Vec<ImplSig>

The impl headers this module owns — the bodies stay behind, and what crosses is that the implementation exists and what it promises. Without these, a call in an importing module has a trait and nothing to resolve it to.

items: Vec<Item>

Implementations

impl Interface

pub fn of(program: &Program) -> Interface

Extract the interface of a checked, placed program.

pub fn item(&self, name: &str) -> Option<&Item>

pub fn digest(&self) -> String

A content hash of everything a downstream module can depend on.

Deliberately not a hash of the rendered file: a comment, or a change of field order in the printer, must not invalidate a build. It is a hash of the meaning.

pub fn render(&self) -> String

Render the .becki file.

pub fn parse( module: &str, src: &str, map: &mut SourceMap, diags: &mut Diagnostics, ) -> Interface

Read a .becki back.

The caller’s SourceMap, for the same reason crate::project gives one to every module it loads: a diagnostic about orders.becki has to point into orders.becki. A map made and dropped here would leave every diagnostic carrying a FileId the renderer resolves against somebody else’s file, which is worse than no span at all — it points confidently at an unrelated line.

pub fn exports( &self, ) -> (BTreeMap<Arc<str>, TyDecl>, BTreeMap<Arc<str>, Export>)

Register this interface’s types and names in a checker’s environment.

Trait Implementations

impl Clone for Interface

fn clone(&self) -> Interface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interface

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

Formats the value using the given formatter.

impl Default for Interface

fn default() -> Interface

Returns the “default value” for a type.

impl PartialEq for Interface

fn eq(&self, other: &Interface) -> 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 Eq for Interface

impl StructuralPartialEq for Interface