Struct Socket 

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

A point where downstream elements connect to this element.

Fields

name: PortName

Name of this socket on the owning element.

facets: BTreeSet<Facet>

Facets this socket covers.

description: Option<String>

Optional human-readable description.

Implementations

impl Socket

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

Construct a socket. 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.

Trait Implementations

impl Clone for Socket

fn clone(&self) -> Socket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Socket

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Socket

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Socket

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

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 Socket

impl StructuralPartialEq for Socket