Struct FunctionStub 

pub struct FunctionStub {
    pub annotations: Vec<Annotation>,
    pub variant: Variant,
    pub identifier: Identifier,
    pub input: Vec<Input>,
    pub output: Vec<Output>,
    pub output_type: Type,
    pub span: Span,
    pub id: NodeID,
}

A function stub definition.

Fields

annotations: Vec<Annotation>

Annotations on the function.

variant: Variant

Is this function a transition, inlined, or a regular function?.

identifier: Identifier

The function identifier, e.g., foo in function foo(...) { ... }.

input: Vec<Input>

The function’s input parameters.

output: Vec<Output>

The function’s output declarations.

output_type: Type

The function’s output type.

span: Span

The entire span of the function definition.

id: NodeID

The ID of the node.

Implementations

impl FunctionStub

pub fn new( annotations: Vec<Annotation>, _is_async: bool, variant: Variant, identifier: Identifier, input: Vec<Input>, output: Vec<Output>, span: Span, id: NodeID, ) -> Self

Initialize a new function.

pub fn name(&self) -> Symbol

Returns function name.

pub fn is_main(&self) -> bool

Returns true if the function name is main.

pub fn has_final_output(&self) -> bool

Returns true if any output of the function is a Final

pub fn from_function_core<N: Network>( function: &FunctionCore<N>, program_id: ProgramId, ) -> Self

Converts from snarkvm function type to leo FunctionStub, while also carrying the parent program name.

pub fn from_finalize<N: Network>( function: &FunctionCore<N>, key_name: Symbol, program_id: ProgramId, ) -> Self

pub fn from_view<N: Network>(view: &ViewCore<N>, program_id: ProgramId) -> Self

Construct a Leo FunctionStub from a snarkVM ViewCore (V15 read-only entry). snarkVM’s ViewCore::add_input and ViewCore::add_output enforce matches!(finalize_type, FinalizeType::Plaintext(_)) — see snarkvm/synthesizer/program/src/view/mod.rs — so by the time a ViewCore<N> reaches this constructor, non-plaintext finalize types are unreachable. The panic below matches the defense-in-depth pattern used by from_function_core (Functions do not contain futures as inputs) — disassemble_from_str will surface a clean validation error long before this is hit, so reaching the panic indicates a bug in snarkVM or a caller that bypassed validation entirely.

pub fn from_closure<N: Network>( closure: &ClosureCore<N>, program_id: ProgramId, ) -> Self

Trait Implementations

impl Clone for FunctionStub

fn clone(&self) -> FunctionStub

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionStub

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionStub

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FunctionStub

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

Formats the value using the given formatter.

impl From<Function> for FunctionStub

fn from(function: Function) -> Self

Converts to this type from the input type.

impl From<FunctionStub> for Function

fn from(function: FunctionStub) -> Self

Converts to this type from the input type.

impl Node for FunctionStub

fn span(&self) -> Span

Returns the span of the node.

fn set_span(&mut self, span: Span)

Sets the span of the node.

fn id(&self) -> NodeID

Returns the ID of the node.

fn set_id(&mut self, id: NodeID)

Sets the ID of the node.

impl PartialEq for FunctionStub

fn eq(&self, other: &Self) -> 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 Serialize for FunctionStub

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FunctionStub