Struct ractor::port::output::OutputPort

pub struct OutputPort<TMsg>
where
    TMsg: OutputMessage,
{ /* private fields */ }

An OutputPort is a publish-subscribe mechanism for connecting actors together. It allows actors to emit messages without knowing which downstream actors are subscribed.

You can subscribe to the output port with an ActorRef and a message converter from the output type to the actor’s expected input type. If the actor is dropped or stops, the subscription will be dropped and if the output port is dropped, then the subscription will also be dropped automatically.

Implementations

impl<TMsg> OutputPort<TMsg>

where TMsg: OutputMessage,

pub fn subscribe<TReceiverMsg, F>( &self, receiver: ActorRef<TReceiverMsg>, converter: F )

where F: Fn(TMsg) -> Option<TReceiverMsg> + Send + 'static, TReceiverMsg: Message,

Subscribe to the output port, passing in a converter to convert to the input message of another actor

• receiver - The reference to the actor which will receive forwarded messages
• converter - The converter which will convert the output message type to the receiver’s input type and return [Some(_)] if the message should be forwarded, None if the message should be skipped.

pub fn send(&self, msg: TMsg)

Send a message on the output port

• msg: The message to send

Trait Implementations

impl<TMsg> Default for OutputPort<TMsg>

where TMsg: OutputMessage,

fn default() -> Self

Returns the “default value” for a type.

impl<TMsg> Drop for OutputPort<TMsg>

where TMsg: OutputMessage,

fn drop(&mut self)

Executes the destructor for this type.