Struct AggregateHandle 

pub struct AggregateHandle<A: Aggregate> { /* private fields */ }

Async handle to a running aggregate actor.

Lightweight, cloneable, and Send + Sync. Communicates with the actor thread over a bounded channel.

Type Parameters

• A - The Aggregate type this handle controls.

Implementations

impl<A: Aggregate> AggregateHandle<A>

pub async fn execute( &self, cmd: A::Command, ctx: CommandContext, ) -> Result<Vec<A::DomainEvent>, ExecuteError<A::Error>>

Send a command to the aggregate and wait for the result.

Returns the domain events produced by the command on success.

Arguments

• cmd - The domain command to execute against the aggregate.
• ctx - Cross-cutting metadata (actor identity, correlation ID, etc.).

Returns

The domain events produced by the command on success.

Errors

• ExecuteError::Domain – the aggregate rejected the command.
• ExecuteError::Io – a disk I/O error occurred.
• ExecuteError::ActorGone – the actor thread has exited.

pub async fn state(&self) -> Result<A, StateError>

Read the current aggregate state.

Refreshes the view from disk before returning.

Returns

A clone of the current aggregate state.

Errors

• StateError::Io – a disk I/O error occurred.
• StateError::ActorGone – the actor thread has exited.

pub fn reader(&self) -> &EventReader

Returns a reference to the EventReader for this aggregate’s stream.

pub fn is_alive(&self) -> bool

Check whether the actor backing this handle is still running.

Returns false if the actor thread has exited (e.g. due to idle timeout or shutdown). The store uses this to evict stale handles from its cache and re-spawn the actor on the next get call.

Trait Implementations

impl<A: Aggregate> Clone for AggregateHandle<A>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug + Aggregate> Debug for AggregateHandle<A>

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

Formats the value using the given formatter.