Struct PortRef

pub struct PortRef<M: RemoteMessage> { /* private fields */ }

A reference to a remote port. All messages passed through PortRefs will be serialized.

Implementations

impl<M: RemoteMessage> PortRef<M>

pub fn attest(port_id: PortId) -> Self

The caller attests that the provided PortId can be converted to a reachable, typed port reference.

pub fn attest_reducible( port_id: PortId, reducer_spec: Option<ReducerSpec>, ) -> Self

The caller attests that the provided PortId can be converted to a reachable, typed port reference.

pub fn attest_message_port(actor: &ActorId) -> Self

The caller attests that the provided PortId can be converted to a reachable, typed port reference.

pub fn reducer_spec(&self) -> &Option<ReducerSpec>

The typehash of this port’s reducer, if any. Reducers may be used to coalesce messages sent to a port.

pub fn port_id(&self) -> &PortId

This port’s ID.

pub fn into_port_id(self) -> PortId

Convert this PortRef into its corresponding port id.

pub fn into_once(self) -> OncePortRef<M>

coerce it into OncePortRef so we can send messages to this port from APIs requires OncePortRef.

pub fn send( &self, caps: &impl CanSend, message: M, ) -> Result<(), MailboxSenderError>

Send a message to this port, provided a sending capability, such as [crate::actor::Instance].

pub fn send_with_headers( &self, caps: &impl CanSend, headers: Attrs, message: M, ) -> Result<(), MailboxSenderError>

Send a message to this port, provided a sending capability, such as [crate::actor::Instance]. Additional context can be provided in the form of headers.

pub fn send_serialized( &self, caps: &impl CanSend, message: Serialized, headers: Attrs, )

Send a serialized message to this port, provided a sending capability, such as [crate::actor::Instance].

pub fn into_sink<C: CanSend>(self, caps: C) -> PortSink<C, M>

Convert this port into a sink that can be used to send messages using the given capability.

Trait Implementations

impl<M: RemoteMessage> Bind for PortRef<M>

fn bind(&mut self, bindings: &mut Bindings) -> Result<()>

Remove parameters from bindings, and use them to update itself.

impl<M: RemoteMessage> Clone for PortRef<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug + RemoteMessage> Debug for PortRef<M>

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

Formats the value using the given formatter.

impl<'de, M: RemoteMessage> Deserialize<'de> for PortRef<M>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<M: RemoteMessage> Display for PortRef<M>

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

Formats the value using the given formatter.

impl<M: RemoteMessage> From<&PortRef<M>> for UnboundPort

fn from(port_ref: &PortRef<M>) -> Self

Converts to this type from the input type.

impl<M: RemoteMessage> Hash for PortRef<M>

fn hash<__HM>(&self, __state: &mut __HM)

where __HM: Hasher,

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<M: RemoteMessage + Named> Named for PortRef<M>

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<M: RemoteMessage> Ord for PortRef<M>

fn cmp(&self, other: &Self) -> 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<M: RemoteMessage> PartialEq for PortRef<M>

fn eq(&self, other: &Self) -> 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<M: RemoteMessage> PartialOrd for PortRef<M>

fn partial_cmp(&self, other: &Self) -> 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<M: RemoteMessage> Serialize for PortRef<M>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<M: RemoteMessage> Unbind for PortRef<M>

fn unbind(&self, bindings: &mut Bindings) -> Result<()>

Extract parameters from itself and store them in bindings.

impl<M: RemoteMessage> Eq for PortRef<M>