Struct PortId

pub struct PortId(pub ActorId, pub u64);

Port ids identify [crate::mailbox::Port]s of an actor.

TODO: consider moving [crate::mailbox::Port] to PortRef in this module for consistency with actors,

Tuple Fields

0: ActorId

1: u64

Implementations

impl PortId

pub fn actor_id(&self) -> &ActorId

The ID of the port’s owning actor.

pub fn into_actor_id(self) -> ActorId

Convert this port ID into an actor ID.

pub fn index(&self) -> u64

This port’s index.

pub fn send(&self, caps: &impl CanSend, serialized: &Serialized)

Send a serialized message to this port, provided a sending capability, such as [crate::actor::Instance]. It is the sender’s responsibility to ensure that the provided message is well-typed.

pub fn send_with_headers( &self, caps: &impl CanSend, serialized: &Serialized, headers: Attrs, )

Send a serialized message to this port, provided a sending capability, such as [crate::actor::Instance], with additional context provided by headers. It is the sender’s responsibility to ensure that the provided message is well-typed.

pub fn split( &self, caps: &impl CanSplitPort, reducer_spec: Option<ReducerSpec>, ) -> Result<PortId>

Split this port, returning a new port that relays messages to the port through a local proxy, which may coalesce messages.

Trait Implementations

impl Clone for PortId

fn clone(&self) -> PortId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PortId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PortId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PortId

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

Formats the value using the given formatter.

impl From<PortId> for Reference

fn from(port_id: PortId) -> Self

Converts to this type from the input type.

impl FromStr for PortId

type Err = ReferenceParsingError

The associated error which can be returned from parsing.

fn from_str(addr: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for PortId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Named for PortId

fn typename() -> &'static str

The globally unique type name for the type. This should typically be the fully qualified Rust name of the type.

fn typehash() -> u64

A globally unique hash for this type. TODO: actually enforce perfect hashing

fn typeid() -> TypeId

The TypeId for this type. TypeIds are unique only within a binary, and should not be used for global identification.

fn port() -> u64

The globally unique port for this type. Typed ports are in the range of 1<<63..1<<64-1.

fn arm(&self) -> Option<&'static str>

If the named type is an enum, this returns the name of the arm of the value self.

unsafe fn arm_unchecked(self_: *const ()) -> Option<&'static str>

An unsafe version of ‘arm’, accepting a pointer to the value, for use in type-erased settings.

impl Ord for PortId

fn cmp(&self, other: &PortId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PortId

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

fn partial_cmp(&self, other: &PortId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PortId

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 PortId

impl StructuralPartialEq for PortId