Struct snarkvm_compiler::Registers

pub struct Registers<N: Network, A: Aleo<Network = N>> { /* private fields */ }

Implementations

impl<N: Network, A: Aleo<Network = N>> Registers<N, A>

pub fn load_literal(
    &self,
    stack: &Stack<N>,
    operand: &Operand<N>
) -> Result<Literal<N>>

Loads the literal of a given operand from the registers.

Errors

This method will halt if the given operand is not a literal. This method will halt if the register locator is not found. In the case of register members, this method will halt if the member is not found.

pub fn load(&self, stack: &Stack<N>, operand: &Operand<N>) -> Result<Value<N>>

Loads the value of a given operand from the registers.

Errors

This method will halt if the register locator is not found. In the case of register members, this method will halt if the member is not found.

impl<N: Network, A: Aleo<Network = N>> Registers<N, A>

pub fn load_literal_circuit(
    &self,
    stack: &Stack<N>,
    operand: &Operand<N>
) -> Result<Literal<A>>

Loads the literal circuit of a given operand from the registers.

Errors

This method will halt if the given operand is not a literal. This method will halt if the register locator is not found. In the case of register members, this method will halt if the member is not found.

pub fn load_circuit(
    &self,
    stack: &Stack<N>,
    operand: &Operand<N>
) -> Result<Value<A>>

Loads the value of a given operand from the registers.

Errors

This method will halt if the register locator is not found. In the case of register members, this method will halt if the member is not found.

impl<N: Network, A: Aleo<Network = N>> Registers<N, A>

pub fn store_literal(
    &mut self,
    stack: &Stack<N>,
    register: &Register<N>,
    literal: Literal<N>
) -> Result<()>

Assigns the given literal to the given register, assuming the register is not already assigned.

Errors

This method will halt if the given register is a register member. This method will halt if the given register is an input register. This method will halt if the register is already used.

pub fn store(
    &mut self,
    stack: &Stack<N>,
    register: &Register<N>,
    stack_value: Value<N>
) -> Result<()>

Assigns the given value to the given register, assuming the register is not already assigned.

Errors

This method will halt if the given register is a register member. This method will halt if the given register is an input register. This method will halt if the register is already used.

impl<N: Network, A: Aleo<Network = N>> Registers<N, A>

pub fn store_literal_circuit(
    &mut self,
    stack: &Stack<N>,
    register: &Register<N>,
    literal: Literal<A>
) -> Result<()>

Assigns the given literal to the given register, assuming the register is not already assigned.

Errors

This method will halt if the given register is a register member. This method will halt if the given register is an input register. This method will halt if the register is already used.

pub fn store_circuit(
    &mut self,
    stack: &Stack<N>,
    register: &Register<N>,
    circuit_value: Value<A>
) -> Result<()>

Assigns the given value to the given register, assuming the register is not already assigned.

Errors

This method will halt if the given register is a register member. This method will halt if the given register is an input register. This method will halt if the register is already used.

impl<N: Network, A: Aleo<Network = N>> Registers<N, A>

pub fn new(call_stack: CallStack<N>, register_types: RegisterTypes<N>) -> Self

Initializes a new set of registers, given the call stack.

pub fn call_stack(&self) -> CallStack<N>

Returns the current call stack.

pub fn caller(&self) -> Result<Address<N>>

Returns the transition caller.

pub fn caller_circuit(&self) -> Result<Address<A>>

Returns the transition caller, as a circuit.

pub fn set_caller(&mut self, caller: Address<N>)

Sets the transition caller.

pub fn set_caller_circuit(&mut self, caller_circuit: Address<A>)

Sets the transition caller, as a circuit.

pub fn tvk(&self) -> Result<Field<N>>

Returns the transition view key.

pub fn tvk_circuit(&self) -> Result<Field<A>>

Returns the transition view key, as a circuit.

pub fn set_tvk(&mut self, tvk: Field<N>)

Sets the transition view key.

pub fn set_tvk_circuit(&mut self, tvk_circuit: Field<A>)

Sets the transition view key, as a circuit.

pub fn ensure_console_and_circuit_registers_match(&self) -> Result<()>

Ensure the console and circuit registers match.

Trait Implementations

impl<N: Clone + Network, A: Clone + Aleo<Network = N>> Clone for Registers<N, A>

fn clone(&self) -> Registers<N, A>

Returns a copy of the value.

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

Performs copy-assignment from source.