openvm_instructions::program

Struct Program

Source
pub struct Program<F> {
    pub step: u32,
    pub pc_base: u32,
    pub max_num_public_values: usize,
    /* private fields */
}

Fields§

§step: u32§pc_base: u32§max_num_public_values: usize

The upper bound of the number of public values the program would publish. Currently, this won’t result any constraint. But users should always be aware of the limit of public values when they write programs.

Implementations§

Source§

impl<F: Field> Program<F>

Source

pub fn new_empty(step: u32, pc_base: u32, max_num_public_values: usize) -> Self

Source

pub fn new_without_debug_infos( instructions: &[Instruction<F>], step: u32, pc_base: u32, max_num_public_values: usize, ) -> Self

Source

pub fn from_instructions_and_debug_infos( instructions: &[Instruction<F>], debug_infos: &[Option<DebugInfo>], ) -> Self

We assume that pc_start = pc_base = 0 everywhere except the RISC-V programs, until we need otherwise We use DEFAULT_PC_STEP for consistency with RISC-V

Source

pub fn strip_debug_infos(self) -> Self

Source

pub fn from_instructions(instructions: &[Instruction<F>]) -> Self

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn instructions(&self) -> Vec<Instruction<F>>

Source

pub fn debug_infos(&self) -> Vec<Option<DebugInfo>>

Source

pub fn enumerate_by_pc(&self) -> Vec<(u32, Instruction<F>, Option<DebugInfo>)>

Source

pub fn get_instruction_and_debug_info( &self, index: usize, ) -> Option<(Instruction<F>, Option<DebugInfo>)>

Source

pub fn push_instruction_and_debug_info( &mut self, instruction: Instruction<F>, debug_info: Option<DebugInfo>, )

Source

pub fn push_instruction(&mut self, instruction: Instruction<F>)

Source

pub fn append(&mut self, other: Program<F>)

Trait Implementations§

Source§

impl<F: Clone> Clone for Program<F>

Source§

fn clone(&self) -> Program<F>

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<F: Debug> Debug for Program<F>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<F: Default> Default for Program<F>

Source§

fn default() -> Program<F>

Returns the “default value” for a type. Read more
Source§

impl<'de, F> Deserialize<'de> for Program<F>
where F: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<F: Field> Display for Program<F>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<F: Field> From<Program<F>> for VmExe<F>

Source§

fn from(program: Program<F>) -> Self

Converts to this type from the input type.
Source§

impl<F> Serialize for Program<F>
where F: Serialize,

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<F> Freeze for Program<F>

§

impl<F> RefUnwindSafe for Program<F>
where F: RefUnwindSafe,

§

impl<F> Send for Program<F>
where F: Send,

§

impl<F> Sync for Program<F>
where F: Sync,

§

impl<F> Unpin for Program<F>
where F: Unpin,

§

impl<F> UnwindSafe for Program<F>
where F: 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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

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<U> for T
where U: From<T>,

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

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<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,