Struct OracleSchedule 

pub struct OracleSchedule { /* private fields */ }

Every oracle an IOP commits, grouped into the rounds they are committed in.

A round is the run of oracles sent between two challenge samples.

A challenge can only be derived once the commitments before it are absorbed.

So a round closes the moment its challenge is drawn, and takes no further members.

recv, recv, sample, recv, sample, recv, recv, recv
\__________/        \__/          \______________/
   round 0         round 1           round 2

A flat spec list cannot say where those boundaries fall.

A caller that commits a whole round as one oracle needs them.

Implementations

impl OracleSchedule

pub const fn new() -> Self

Creates an empty schedule.

pub fn push(&mut self, spec: OracleSpec)

Appends one oracle to the round currently open.

pub fn end_round(&mut self)

Closes the round currently open, so later oracles start a new one.

Does nothing when no oracle has arrived since the last close.

Calling it wherever a challenge could be drawn is therefore always safe.

pub fn specs(&self) -> &[OracleSpec]

Every oracle in the schedule, in arrival order, with round boundaries dropped.

pub fn into_specs(self) -> Vec<OracleSpec>

Consumes the schedule and returns every oracle, with round boundaries dropped.

pub const fn n_rounds(&self) -> usize

The number of closed rounds.

pub fn rounds(&self) -> impl Iterator<Item = &[OracleSpec]>

The oracles of each closed round, in commit order.

pub fn merged_specs(&self) -> Vec<OracleSpec>

One spec per round: the oracle that round’s oracles are committed as.

This is the coarser list an underlying channel is configured with.

A round is masked as a whole, so its oracle is zero-knowledge if any member is.

Trait Implementations

impl Clone for OracleSchedule

fn clone(&self) -> OracleSchedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OracleSchedule

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

Formats the value using the given formatter.

impl Default for OracleSchedule

fn default() -> OracleSchedule

Returns the “default value” for a type.

impl Eq for OracleSchedule

impl PartialEq for OracleSchedule

fn eq(&self, other: &OracleSchedule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OracleSchedule