Struct Bus

pub struct Bus { /* private fields */ }

Data structure that helps with managing buses, it allows you to connect &[GateIndex] to it as well as providing a &[GateIndex] to connect to other components.

It is basically syntactic sugar for a set of or gates.

Example

let input1 = constant(0x01u8);
let input2 = constant(0x10u8);

let bus = Bus::new(&mut g, 8, "bus");
bus.connect(&mut g, &input1);
bus.connect(&mut g, &input2);

let output = g.output(bus.bits(), "result");

let ig = &g.init();
assert_eq!(output.u8(ig), 0x11);

Implementations

impl Bus

pub fn new<S: Into<String>>( g: &mut GateGraphBuilder, width: usize, name: S, ) -> Self

Returns a new Bus of width width with name name.

pub fn connect(&self, g: &mut GateGraphBuilder, other: &[GateIndex])

Connects a &[GateIndex] to the bus, each bit of the output of the bus will be set to the or of every corresponding bit in the inputs.

Panics

Will panic if other.len() != self.len(). Use connect_some if this is not your desired behavior.

pub fn connect_some(&self, g: &mut GateGraphBuilder, other: &[GateIndex])

Connects a &[GateIndex] to the bus, each bit of the output of the bus will be set to the or of every corresponding bit in the inputs.

If there are excess bits in other, they won’t get connected to the bus. If there are missing bits in other only other.len() will be connected to the bus.

pub fn merge(&self, g: &mut GateGraphBuilder, other: Bus) -> Bus

Connects the bits of other to self and returns a clone of self.

pub fn len(&self) -> usize

Returns the width of the bus.

pub fn is_empty(&self) -> bool

Returns true if self.len() == 0.

pub fn bits(&self) -> &[GateIndex]

Returns a &[GateIndex] to connect to other components.

pub fn bx(&self, n: usize) -> GateIndex

Returns the GateIndex of the nth bit in the bus.

Panics

Will panic if n >= self.len().

pub fn b0(&self) -> GateIndex

Returns the GateIndex of the 0th bit in the bus.

Panics

Will panic if self.is_empty().

pub fn split_wires(&self, g: &mut GateGraphBuilder, other: &mut [Wire])

Connects the bus to a series of Wires.

Panics

Will panic if self.len() != other.len().

Trait Implementations

impl Clone for Bus

fn clone(&self) -> Bus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bus

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

Formats the value using the given formatter.

impl Into<Vec<GateIndex>> for Bus

fn into(self) -> Vec<GateIndex>

Converts this type into the (usually inferred) input type.