Struct UWD 

pub struct UWD<T, J> { /* private fields */ }

An undirected wiring diagram (UWD).

Implementations

impl<T, J> UWD<T, J>

pub fn empty() -> Self

Constructs an empty UWD.

pub fn with_ports(outer_ports: Ports<T>) -> Self

Constructs a UWD with the given interface for its outer ports.

pub fn boxes( &self, ) -> impl Iterator<Item = (&NameSegment, &LabelSegment, &Ports<T>)>

Iterates over the diagram’s boxes along with their ports.

pub fn outer_ports(&self) -> &Ports<T>

Gets the diagram’s outer ports.

pub fn has_box(&self, box_name: NameSegment) -> bool

Returns whether the diagram contains a box.

pub fn has_port(&self, box_name: NameSegment, port_name: NameSegment) -> bool

Returns whether the diagram contains a box with a specific port.

pub fn has_outer_port(&self, port_name: NameSegment) -> bool

Returns whether the diagram contains an outer port.

pub fn add_box(&mut self, name: NameSegment, label: LabelSegment)

Adds a box with empty interface.

pub fn add_box_with_ports( &mut self, name: NameSegment, label: LabelSegment, ports: Ports<T>, )

Adds a box with the given interface.

pub fn add_port( &mut self, box_name: NameSegment, port_name: NameSegment, label: LabelSegment, ty: T, ) -> Option<()>

Adds a port to a box.

pub fn add_outer_port(&mut self, name: NameSegment, label: LabelSegment, ty: T)

Adds a port to the outer box.

impl<T: Clone + Eq, J: Clone + Eq + Hash> UWD<T, J>

pub fn junctions(&self) -> impl Iterator<Item = J>

Iterates over the diagram’s junctions.

pub fn has_junction(&self, junction: &J) -> bool

Returns whether the diagram contains a junction.

pub fn get(&self, box_name: NameSegment, port_name: NameSegment) -> Option<&J>

Gets the junction assigned to a port on a box, if any.

pub fn get_outer(&self, port_name: NameSegment) -> Option<&J>

Gets the junction assigned to an outer port, if any.

pub fn set( &mut self, box_name: NameSegment, port_name: NameSegment, junction: J, ) -> Option<()>

Assigns a port on a box to a junction.

pub fn set_outer(&mut self, port_name: NameSegment, junction: J) -> Option<()>

Assigns an outer port to a junction.

Trait Implementations

impl<T: Clone, J: Clone> Clone for UWD<T, J>

fn clone(&self) -> UWD<T, J>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, J> Default for UWD<T, J>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Display + Clone + Eq, J: Display + Clone + Eq + Hash> Display for UWD<T, J>

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

Formats the value using the given formatter.

impl<T: Display + Clone + Eq, J: Display + Clone + Eq + Hash> ToDoc for UWD<T, J>

fn to_doc<'a>(&self) -> D<'a>

Pretty prints the object, returning a doc.

impl<T: Clone + Eq, J: Clone + Eq + Hash> Validate for UWD<T, J>

type ValidationError = InvalidUWD

The type of a validation error.

fn validate(&self) -> Result<(), NonEmpty<Self::ValidationError>>

Validates the object.