pub struct PicusCodegen { /* private fields */ }Expand description
Code generator for PCL.
Trait Implementations§
Source§impl Clone for PicusCodegen
impl Clone for PicusCodegen
Source§fn clone(&self) -> PicusCodegen
fn clone(&self) -> PicusCodegen
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<'c: 's, 's> Codegen<'c, 's> for PicusCodegen
impl<'c: 's, 's> Codegen<'c, 's> for PicusCodegen
Source§type FuncOutput = PicusModuleLowering
type FuncOutput = PicusModuleLowering
Implementation of the lowering behavior.
Source§type Error = PicusCodegenError
type Error = PicusCodegenError
Error type of the code generator.
Source§fn initialize(state: &'s Self::State) -> Self
fn initialize(state: &'s Self::State) -> Self
Initializes the code generator.
Source§fn set_prime_field(&self, prime: Prime) -> Result<(), PicusCodegenError>
fn set_prime_field(&self, prime: Prime) -> Result<(), PicusCodegenError>
Sets the prime field used by the circuit. Read more
Source§fn define_main_function(
&self,
advice_io: &AdviceIO,
instance_io: &InstanceIO,
) -> Result<Self::FuncOutput, PicusCodegenError>
fn define_main_function( &self, advice_io: &AdviceIO, instance_io: &InstanceIO, ) -> Result<Self::FuncOutput, PicusCodegenError>
Defines the entrypoint function of the circuit.
Source§fn on_scope_end(
&self,
_scope: Self::FuncOutput,
) -> Result<(), PicusCodegenError>
fn on_scope_end( &self, _scope: Self::FuncOutput, ) -> Result<(), PicusCodegenError>
Callback called when a scope ends.
Source§fn generate_output(self) -> Result<Self::Output, PicusCodegenError>
fn generate_output(self) -> Result<Self::Output, PicusCodegenError>
Consumes the code generator and returns the final output.
Source§fn define_function(
&self,
name: &str,
inputs: usize,
outputs: usize,
) -> Result<Self::FuncOutput, PicusCodegenError>
fn define_function( &self, name: &str, inputs: usize, outputs: usize, ) -> Result<Self::FuncOutput, PicusCodegenError>
Defines an empty function.
Source§fn define_function_with_body<FN, L, I>(
&self,
name: &str,
inputs: usize,
outputs: usize,
f: FN,
) -> Result<(), Self::Error>where
FN: FnOnce(&Self::FuncOutput, &[Slot], &[Slot]) -> Result<I, Self::Error>,
I: IntoIterator<Item = L>,
L: LowerableStmt,
fn define_function_with_body<FN, L, I>(
&self,
name: &str,
inputs: usize,
outputs: usize,
f: FN,
) -> Result<(), Self::Error>where
FN: FnOnce(&Self::FuncOutput, &[Slot], &[Slot]) -> Result<I, Self::Error>,
I: IntoIterator<Item = L>,
L: LowerableStmt,
Defines a function filled with the given body.
Source§fn define_main_function_with_body<L>(
&self,
advice_io: &CircuitIO<Advice>,
instance_io: &CircuitIO<Instance>,
stmts: impl IntoIterator<Item = L>,
) -> Result<(), Self::Error>where
L: LowerableStmt + Debug,
fn define_main_function_with_body<L>(
&self,
advice_io: &CircuitIO<Advice>,
instance_io: &CircuitIO<Instance>,
stmts: impl IntoIterator<Item = L>,
) -> Result<(), Self::Error>where
L: LowerableStmt + Debug,
Defines the entrypoint function of the circuit and fills it with the given body.
Auto Trait Implementations§
impl Freeze for PicusCodegen
impl !RefUnwindSafe for PicusCodegen
impl !Send for PicusCodegen
impl !Sync for PicusCodegen
impl Unpin for PicusCodegen
impl !UnwindSafe for PicusCodegen
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T, O> EquivalentTo<O> for T
impl<T, O> EquivalentTo<O> for T
Source§impl<L, R, E> EqvRelation<&[L], &[R]> for Ewhere
E: EqvRelation<L, R>,
impl<L, R, E> EqvRelation<&[L], &[R]> for Ewhere
E: EqvRelation<L, R>,
Source§impl<L, R, E> EqvRelation<&L, &R> for Ewhere
E: EqvRelation<L, R>,
impl<L, R, E> EqvRelation<&L, &R> for Ewhere
E: EqvRelation<L, R>,
Source§impl<L, R, E> EqvRelation<&mut L, &mut R> for Ewhere
E: EqvRelation<L, R>,
impl<L, R, E> EqvRelation<&mut L, &mut R> for Ewhere
E: EqvRelation<L, R>,
Source§impl<L, R, E, const N: usize> EqvRelation<[L; N], [R; N]> for Ewhere
E: EqvRelation<L, R>,
impl<L, R, E, const N: usize> EqvRelation<[L; N], [R; N]> for Ewhere
E: EqvRelation<L, R>,
Source§impl<L, R, E> EqvRelation<Box<L>, Box<R>> for Ewhere
E: EqvRelation<L, R>,
impl<L, R, E> EqvRelation<Box<L>, Box<R>> for Ewhere
E: EqvRelation<L, R>,
Source§impl<'l, 'r, L, R, E> EqvRelation<Cow<'l, L>, Cow<'r, R>> for E
impl<'l, 'r, L, R, E> EqvRelation<Cow<'l, L>, Cow<'r, R>> for E
Source§impl<L, R, E> EqvRelation<Option<L>, Option<R>> for Ewhere
E: EqvRelation<L, R>,
impl<L, R, E> EqvRelation<Option<L>, Option<R>> for Ewhere
E: EqvRelation<L, R>,
Source§impl<L, R, E> EqvRelation<Rc<L>, Rc<R>> for Ewhere
E: EqvRelation<L, R>,
impl<L, R, E> EqvRelation<Rc<L>, Rc<R>> for Ewhere
E: EqvRelation<L, R>,
Source§impl<L, LErr, R, RErr, E> EqvRelation<Result<L, LErr>, Result<R, RErr>> for Ewhere
E: EqvRelation<L, R>,
impl<L, LErr, R, RErr, E> EqvRelation<Result<L, LErr>, Result<R, RErr>> for Ewhere
E: EqvRelation<L, R>,
Source§impl<L, R, E> EqvRelation<Vec<L>, Vec<R>> for Ewhere
E: EqvRelation<L, R>,
impl<L, R, E> EqvRelation<Vec<L>, Vec<R>> for Ewhere
E: EqvRelation<L, R>,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.