Enum Item 

pub enum Item {
    Procedure(Procedure),
    Constant(Constant),
    Type(TypeDecl),
}

Represents an exportable item from a crate::ast::Module.

Variants

Procedure(Procedure)

A locally-defined procedure.

Constant(Constant)

A locally-defined constant.

Type(TypeDecl)

A locally-defined type.

Implementations

impl Item

pub fn with_docs(self, docs: Option<Span<String>>) -> Self

Adds documentation to this export.

pub fn name(&self) -> &Ident

Returns the name of the exported procedure.

pub fn docs(&self) -> Option<&str>

Returns the documentation for this item.

pub fn attributes(&self) -> Option<&AttributeSet>

Returns the attributes for this item, if it is a procedure.

pub fn visibility(&self) -> Visibility

Returns the visibility of this item (e.g. public or private).

See Visibility for more details on what visibilities are supported.

pub fn signature(&self) -> Option<&FunctionType>

Returns a reference to the type signature of this item, if it is a procedure, and known.

pub fn num_locals(&self) -> usize

Returns the number of automatically-allocated words of memory this item requires for the storage of temporaries/local variables.

NOTE: This is only applicable for procedure items - the value 0 will be returned if this is a non-procedure item, or if the type of item is not yet known.

pub fn is_main(&self) -> bool

Returns true if this procedure is the program entrypoint.

pub fn unwrap_procedure(&self) -> &Procedure

Unwraps this Item as a Procedure, or panic.

pub fn invoked<'a, 'b: 'a>(&'b self) -> impl Iterator<Item = &'a Invoke> + 'a

Get an iterator over the set of other procedures invoked from this procedure.

NOTE: This only applies to Procedures, other types currently return an empty iterator whenever called.

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl Eq for Item

impl From<Item> for Form

fn from(item: Item) -> Self

Converts to this type from the input type.

impl PartialEq for Item

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

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl Spanned for Item

fn span(&self) -> SourceSpan

impl StructuralPartialEq for Item