Struct snarkvm_compiler::Function

source · [−]

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

Implementations

source

impl<N: Network> Function<N>

source

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

Initializes a new function with the given name.

source

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

Returns the name of the function.

source

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

Returns the function inputs.

source

pub fn input_types(&self) -> Vec<ValueType<N>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Returns the function input types.

source

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

Returns the function instructions.

source

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

Returns the function outputs.

source

pub fn output_types(&self) -> Vec<ValueType<N>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Returns the function output types.

source

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

Returns the function finalize logic.

source

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

Returns the function finalize command.

source

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

Returns the function finalize logic.

source

impl<N: Network> Function<N>

source

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

Adds the given instruction to the function.

Errors

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

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Prints the function as a string.

source

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

source

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

Prints the function as a string.

source

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

source

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

Reads the function from a buffer.

source

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

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

source

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

source

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.

source

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

source

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

Parses a string into a function.

source

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

source

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

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

1.0.0 · source

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. Read more

source

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

source

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

Writes the function to a buffer.

source

fn to_bytes_le(&self) -> Result<Vec<u8, Global>, Error>

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

source

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

source

fn type_name() -> &'static str

Returns the type name as a string.

source

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

source

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

source

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

Auto Trait Implementations

impl<N> RefUnwindSafe for Function<N> where
 N: RefUnwindSafe,
 <N as Environment>::Field: RefUnwindSafe,
 <N as Environment>::Projective: RefUnwindSafe,
 <N as Environment>::Scalar: RefUnwindSafe,

impl<N> Send for Function<N>

impl<N> Sync for Function<N>

impl<N> Unpin for Function<N> where
 N: Unpin,
 <N as Environment>::Field: Unpin,
 <N as Environment>::Projective: Unpin,
 <N as Environment>::Scalar: Unpin,

impl<N> UnwindSafe for Function<N> where
 N: UnwindSafe,
 <N as Environment>::Field: UnwindSafe,
 <N as Environment>::Projective: UnwindSafe,
 <N as Environment>::Scalar: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct snarkvm_compiler::Function

Implementations

impl<N: Network> Function<N>

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

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

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

pub fn input_types(&self) -> Vec<ValueType<N>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

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

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

pub fn output_types(&self) -> Vec<ValueType<N>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

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

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

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

impl<N: Network> Function<N>

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

Errors

Trait Implementations

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

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

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

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

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

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

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

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

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

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

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

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

type Err = Error

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

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

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

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

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

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

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

fn to_bytes_le(&self) -> Result<Vec<u8, Global>, Error>

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

fn type_name() -> &'static str

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

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

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

Auto Trait Implementations

impl<N> RefUnwindSafe for Function<N> where N: RefUnwindSafe, <N as Environment>::Field: RefUnwindSafe, <N as Environment>::Projective: RefUnwindSafe, <N as Environment>::Scalar: RefUnwindSafe,

impl<N> Send for Function<N>

impl<N> Sync for Function<N>

impl<N> Unpin for Function<N> where N: Unpin, <N as Environment>::Field: Unpin, <N as Environment>::Projective: Unpin, <N as Environment>::Scalar: Unpin,

impl<N> UnwindSafe for Function<N> where N: UnwindSafe, <N as Environment>::Field: UnwindSafe, <N as Environment>::Projective: UnwindSafe, <N as Environment>::Scalar: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

pub fn input_types(&self) -> Vec<ValueType<N>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn output_types(&self) -> Vec<ValueType<N>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

impl<N> RefUnwindSafe for Function<N> where
N: RefUnwindSafe,
<N as Environment>::Field: RefUnwindSafe,
<N as Environment>::Projective: RefUnwindSafe,
<N as Environment>::Scalar: RefUnwindSafe,

impl<N> Unpin for Function<N> where
N: Unpin,
<N as Environment>::Field: Unpin,
<N as Environment>::Projective: Unpin,
<N as Environment>::Scalar: Unpin,

impl<N> UnwindSafe for Function<N> where
N: UnwindSafe,
<N as Environment>::Field: UnwindSafe,
<N as Environment>::Projective: UnwindSafe,
<N as Environment>::Scalar: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,