Struct snarkvm_synthesizer::program::Function

pub struct Function<N: Network> { /* private fields */ }

Implementations

impl<N: Network> Function<N>

pub fn new(name: Identifier<N>) -> Self

Initializes a new function with the given name.

pub const fn name(&self) -> &Identifier<N>

Returns the name of the function.

pub const fn inputs(&self) -> &IndexSet<Input<N>>

Returns the function inputs.

pub fn input_types(&self) -> Vec<ValueType<N>>

Returns the function input types.

pub fn instructions(&self) -> &[Instruction<N>]

Returns the function instructions.

pub const fn outputs(&self) -> &IndexSet<Output<N>>

Returns the function outputs.

pub fn output_types(&self) -> Vec<ValueType<N>>

Returns the function output types.

pub const fn finalize(&self) -> Option<&(FinalizeCommand<N>, Finalize<N>)>

Returns the function finalize logic.

pub fn finalize_command(&self) -> Option<&FinalizeCommand<N>>

Returns the function finalize command.

pub fn finalize_logic(&self) -> Option<&Finalize<N>>

Returns the function finalize logic.

impl<N: Network> Function<N>

pub fn add_instruction(&mut self, instruction: Instruction<N>) -> Result<()>

Adds the given instruction to the function.

Errors

This method will halt if there are output statements already. This method will halt if the maximum number of instructions has been reached. This method will halt if a finalize command has been added.

Trait Implementations

impl<N: Clone + Network> Clone for Function<N>

fn clone(&self) -> Function<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for Function<N>

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

Prints the function as a string.

impl<N: Network> Display for Function<N>

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

Prints the function as a string.

impl<N: Network> FromBytes for Function<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads the function from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N: Network> FromStr for Function<N>

fn from_str(string: &str) -> Result<Self>

Returns a function from a string literal.

type Err = Error

The associated error which can be returned from parsing.

impl<N: Network> Parser for Function<N>

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string into a function.

impl<N: PartialEq + Network> PartialEq<Function<N>> for Function<N>

fn eq(&self, other: &Function<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: Network> ToBytes for Function<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the function to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8, Global>, Error>where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N: Network> TypeName for Function<N>

fn type_name() -> &'static str

Returns the type name as a string.

impl<N: Eq + Network> Eq for Function<N>

impl<N: Network> StructuralEq for Function<N>

impl<N: Network> StructuralPartialEq for Function<N>