snarkvm_synthesizer_program/traits/
command.rs

1// Copyright 2024-2025 Aleo Network Foundation
2// This file is part of the snarkVM library.
3
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at:
7
8// http://www.apache.org/licenses/LICENSE-2.0
9
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16use console::{
17    network::Network,
18    prelude::{FromBytes, Parser, ToBytes},
19    program::{Identifier, Register},
20};
21
22pub trait CommandTrait<N: Network>: Clone + Parser + FromBytes + ToBytes {
23    /// Returns the destination registers of the command.
24    fn destinations(&self) -> Vec<Register<N>>;
25    /// Returns the branch target, if the command is a branch command.
26    fn branch_to(&self) -> Option<&Identifier<N>>;
27    /// Returns the position name, if the command is a position command.
28    fn position(&self) -> Option<&Identifier<N>>;
29    /// Returns `true` if the command is a call instruction.
30    fn is_call(&self) -> bool;
31    /// Returns `true` if the command is a cast to record instruction.
32    fn is_cast_to_record(&self) -> bool;
33    /// Returns `true` if the command is a write operation.
34    fn is_write(&self) -> bool;
35}