Struct Plug 

pub struct Plug {
    pub name: PortName,
    pub facets: BTreeSet<Facet>,
    pub description: Option<String>,
}

A point where an element needs to connect to an upstream.

Fields

name: PortName

Name of this plug on the owning element.

facets: BTreeSet<Facet>

Facets that any fitting socket must cover.

description: Option<String>

Optional human-readable description.

Implementations

impl Plug

pub fn new( name: PortName, facets: BTreeSet<Facet>, ) -> Result<Self, AttributeError>

Construct a plug. Rejects an empty facet set per SRD-0005 D8.

pub fn with_description(self, description: impl Into<String>) -> Self

Builder-style setter for the description.

pub fn fits(&self, socket: &Socket) -> bool

This plug fits the given socket iff the socket’s facet set is a superset of the plug’s.

Trait Implementations

impl Clone for Plug

fn clone(&self) -> Plug

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Plug

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Plug

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Plug

fn eq(&self, other: &Plug) -> 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 Serialize for Plug

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Plug

impl StructuralPartialEq for Plug