Struct ProcedureAlias 

pub struct ProcedureAlias { /* private fields */ }

Represents a procedure that acts like it is locally-defined, but delegates to an externally- defined procedure.

These procedure “aliases” do not have a concrete representation in the module, but are instead resolved during compilation to refer directly to the aliased procedure, regardless of whether the caller is in the current module, or in another module.

Implementations

impl ProcedureAlias

pub fn new(name: ProcedureName, target: AliasTarget) -> Self

Creates a new procedure alias called name, which resolves to target.

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

Adds documentation to this procedure alias.

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

Returns the documentation associated with this declaration.

pub fn name(&self) -> &ProcedureName

Returns the name of this alias within its containing module.

If the procedure is simply re-exported with the same name, this will be equivalent to self.target().name

pub fn target(&self) -> &AliasTarget

Returns the target of this procedure alias

pub fn target_mut(&mut self) -> &mut AliasTarget

Returns a mutable reference to the target of this procedure alias

pub fn is_absolute(&self) -> bool

Returns true if this procedure uses an absolute target path

pub fn is_renamed(&self) -> bool

Returns true if this alias uses a different name than the target procedure

Trait Implementations

impl Clone for ProcedureAlias

fn clone(&self) -> ProcedureAlias

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcedureAlias

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

Formats the value using the given formatter.

impl PartialEq for ProcedureAlias

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

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 ProcedureAlias

fn span(&self) -> SourceSpan

impl Eq for ProcedureAlias

impl StructuralPartialEq for ProcedureAlias