Struct PortsIn 

pub struct PortsIn { /* private fields */ }

Declared input ports available to a node execution boundary.

Implementations

impl PortsIn

pub fn new(port_ids: impl Into<Vec<PortId>>) -> Self

Create input handles with declared port identifiers and no channels.

pub fn from_handles( port_ids: impl Into<Vec<PortId>>, handles: impl Into<Vec<InputPortHandle>>, ) -> Self

Create input handles from declared ports and connected channel handles.

pub fn with_metadata_sink( self, metadata_sink: Arc<dyn MetadataSink + Send + Sync>, ) -> Self

Attach a metadata sink for receive-side observations.

pub fn with_node_context(self, context: NodeContext) -> Self

Attach node context for receive-side queue observations.

pub fn port_ids(&self) -> &[PortId]

Declared input port identifiers for this node.

pub const fn is_empty(&self) -> bool

Return whether this node currently has no declared inputs.

pub fn connected_edge_count(&self, port_id: &PortId) -> Option<usize>

Number of connected upstream edges for a declared input port.

pub fn capacity(&self, port_id: &PortId) -> Option<usize>

Capacity of the first connected upstream edge for a declared input port.

pub fn try_recv( &mut self, port_id: &PortId, ) -> Result<Option<PortPacket>, PortRecvError>

Try to receive one packet from a declared input port without blocking.

Returns Ok(None) when the port is declared but no packet is currently queued. Use Self::recv to wait asynchronously.

Errors

Returns an error if the port is undeclared or all upstream senders have disconnected.

pub async fn recv( &mut self, port_id: &PortId, cancellation: &CancellationToken, ) -> Result<Option<PortPacket>, PortRecvError>

Receive one packet from a declared input port, waiting asynchronously.

Returns Ok(None) when the port is declared but has no connected upstream edges. Connected ports wait until a packet arrives, every upstream edge disconnects, or cancellation is observed.

Errors

Returns an error if the port is undeclared, all upstream senders have disconnected, or cancellation is observed.

pub async fn recv_any( &mut self, cancellation: &CancellationToken, ) -> Result<Option<(PortId, PortPacket)>, PortRecvError>

Receive one packet from any declared input port, waiting asynchronously.

Returns the port that produced the packet with the packet itself. Returns Ok(None) when the node has no declared inputs or every input is closed or disconnected.

Errors

Returns an error if cancellation is observed while waiting.

Trait Implementations

impl Default for PortsIn

fn default() -> PortsIn

Returns the “default value” for a type.