Struct Instance 

pub struct Instance<A: Actor> { /* private fields */ }

An actor instance. This is responsible for managing a running actor, including its full lifecycle, supervision, signal management, etc. Instances can represent a managed actor or a “client” actor that has joined the proc.

Implementations

impl<A: Actor> Instance<A>

pub fn self_id(&self) -> &ActorId

This instance’s actor ID.

pub fn introspect_payload(&self) -> IntrospectResult

Snapshot of this actor’s introspection payload.

Returns an IntrospectResult built from live InstanceCell state, without going through the actor message loop. This is safe to call from within a handler on the same actor (no self-send deadlock).

The snapshot is best-effort: it reflects framework-owned state (status, message count, flight recorder, supervision children) at the instant of the call. parent is left as None — callers are responsible for setting topology context.

Note: this acquires a write lock on the flight recorder spool and clones its contents. Suitable for occasional introspection requests, not for hot paths.

pub fn publish_attrs(&self, attrs: Attrs)

Publish domain-specific properties for introspection.

Publish a complete Attrs bag for introspection. Replaces any previously published attrs.

Debug builds assert that every key in the bag is tagged with the INTROSPECT meta-attribute.

pub fn publish_attr<T: AttrValue>(&self, key: Key<T>, value: T)

Publish a single attr key-value pair for introspection. Merges into existing published attrs (insert or overwrite).

Debug builds assert that the key is tagged with the INTROSPECT meta-attribute.

pub fn set_system(&self)

Mark this actor as system/infrastructure. System actors are hidden by default in the TUI (toggled via s).

pub fn set_query_child_handler( &self, handler: impl Fn(&Reference) -> IntrospectResult + Send + Sync + 'static, )

Register a callback for resolving non-addressable children.

The callback runs on the actor’s introspect task (not the actor loop), so it must be Send + Sync and must not access actor-mutable state. Capture cloned Proc references.

Only HostAgent uses this today — for resolving system procs that have no independent ProcAgent.

pub fn stop(&self, reason: &str) -> Result<(), ActorError>

Signal the actor to stop.

pub fn abort(&self, reason: &str) -> Result<(), ActorError>

Signal the actor to abort with a provided reason.

pub fn open_port<M: Message>(&self) -> (PortHandle<M>, PortReceiver<M>)

Open a new port that accepts M-typed messages. The returned port may be freely cloned, serialized, and passed around. The returned receiver should only be retained by the actor responsible for processing the delivered messages.

pub fn open_once_port<M: Message>( &self, ) -> (OncePortHandle<M>, OncePortReceiver<M>)

Open a new one-shot port that accepts M-typed messages. The returned port may be used to send a single message; ditto the receiver may receive a single message.

pub fn locals(&self) -> &ActorLocalStorage

Get the per-instance local storage.

pub fn post(&self, port_id: PortId, headers: Flattrs, message: Any)

Send a message to the actor running on the proc.

pub fn self_message_with_delay<M>( &self, message: M, delay: Duration, ) -> Result<(), ActorError>

where M: Message, A: Handler<M>,

Send a message to the actor itself with a delay usually to trigger some event.

pub async fn handle_supervision_event( &self, actor: &mut A, supervision_event: ActorSupervisionEvent, ) -> Result<(), ActorError>

Handle a supervision event using the provided actor.

pub fn spawn<C: Actor>(&self, actor: C) -> Result<ActorHandle<C>>

Spawn on child on this instance.

pub fn spawn_with_name<C: Actor>( &self, name: &str, actor: C, ) -> Result<ActorHandle<C>>

Spawn a named child actor on this instance. The child gets a descriptive name in its ActorId instead of inheriting this instance’s name. Supervision linkage is preserved.

pub fn child(&self) -> Result<(Instance<()>, ActorHandle<()>)>

Create a new direct child instance.

pub fn port<M: Message>(&self) -> PortHandle<M>

where A: Handler<M>,

Return a handle port handle representing the actor’s message handler for M-typed messages.

pub fn handle(&self) -> ActorHandle<A>

The ActorHandle corresponding to this instance.

pub fn bind<R: Binds<A>>(&self) -> ActorRef<R>

The owning actor ref.

pub fn proc(&self) -> &Proc

The owning proc.

pub fn sequencer(&self) -> &Sequencer

Return this instance’s sequencer.

pub fn instance_id(&self) -> Uuid

Return this instance’s ID.

pub fn parent_handle<P: Actor>(&self) -> Option<ActorHandle<P>>

Return a handle to this instance’s parent actor, if it has one.

impl Instance<()>

pub fn bind_actor_port<M: RemoteMessage>( &self, ) -> (PortHandle<M>, PortReceiver<M>)

See Mailbox::bind_actor_port for details.

Trait Implementations

impl<A: Actor> Actor for &Instance<A>

type A = A

The type of actor associated with this context.

fn instance(&self) -> &Instance<A>

The instance associated with this context.

impl<A: Actor> Actor for Instance<A>

type A = A

The type of actor associated with this context.

fn instance(&self) -> &Instance<A>

The instance associated with this context.

impl<A: Actor> Debug for Instance<A>

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

Formats the value using the given formatter.

impl<A: Actor> Mailbox for &Instance<A>

fn mailbox(&self) -> &Mailbox

The mailbox associated with this context

impl<A: Actor> Mailbox for Instance<A>

fn mailbox(&self) -> &Mailbox

The mailbox associated with this context