Struct dusk_cdf::CircuitDescription

pub struct CircuitDescription<S> { /* private fields */ }

A circuit description file

Since circuit descriptions are often large, it will perform lazy disk I/O, loading only the required data to satisfy the user operation.

Implementations

impl CircuitDescription<File>

pub fn open_read<P>(path: P) -> Result<Self> where
    P: AsRef<Path>, 

Open a CDF file as read-only.

impl<S> CircuitDescription<S> where
    S: Read, 

pub fn by_ref(&mut self) -> CircuitDescription<&mut S>

Create a new instance of the CDF consumer by reference

pub fn context(&mut self) -> Context<&mut S>

Create a new context with a referennce to the underlying source

impl<S> CircuitDescription<S> where
    S: Read + Seek, 

pub fn from_reader(source: S) -> Result<Self>

Create a new circuit description instance.

pub fn fetch_constraint(&mut self, idx: usize) -> Result<Constraint>

Attempt to read an indexed constraint from the source

pub fn fetch_witness(&mut self, idx: usize) -> Result<Witness>

Attempt to read an indexed witness from the source

pub fn fetch_source(
    &mut self,
    idx: usize
) -> Result<FixedText<{ Source::PATH_LEN }>>

Attempt to fetch a path from source cache

impl<S> CircuitDescription<S>

pub fn into_inner(self) -> S

Return the inner source

pub const fn config(&self) -> &Config

CDF file metadata

pub const fn preamble(&self) -> &Preamble

CDF preamble metadata

Trait Implementations

impl<S: Debug> Debug for CircuitDescription<S>

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

Formats the value using the given formatter.

impl<S> Deref for CircuitDescription<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S> DerefMut for CircuitDescription<S>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.