Struct TypedSubscription 

pub struct TypedSubscription<E, State, S: EventStore<Event = E> = Box<dyn EventStore<Event = E>>> { /* private fields */ }

Type-safe subscription with phantom state parameter.

This struct uses phantom types to encode the subscription’s lifecycle state at compile time, preventing invalid operations on subscriptions.

Implementations

impl<E, S> TypedSubscription<E, Uninitialized, S>

where E: Send + Sync, S: EventStore<Event = E>,

pub fn new(event_store: S) -> Self

Creates a new uninitialized subscription with an event store.

impl<E, S> TypedSubscription<E, Uninitialized, S>

where E: Send + Sync + 'static, S: EventStore<Event = E>,

pub fn configure( self, name: SubscriptionName, options: SubscriptionOptions, processor: Box<dyn EventProcessor<Event = E>>, ) -> TypedSubscription<E, Configured, S>

Configures the subscription with name, options, and processor.

This moves the subscription from Uninitialized to Configured state.

impl<E, S> TypedSubscription<E, Configured, S>

where E: Send + Sync + PartialEq + Eq + 'static, S: EventStore<Event = E> + 'static,

pub async fn start(self) -> SubscriptionResult<TypedSubscription<E, Running, S>>

Starts the subscription, beginning event processing.

This moves the subscription from Configured to Running state.

impl<E, S> TypedSubscription<E, Running, S>

where E: Send + Sync + PartialEq + Eq + 'static, S: EventStore<Event = E>,

pub async fn pause(self) -> SubscriptionResult<TypedSubscription<E, Paused, S>>

Pauses the subscription, temporarily stopping event processing.

This moves the subscription from Running to Paused state.

pub async fn stop(self) -> SubscriptionResult<TypedSubscription<E, Stopped, S>>

Stops the subscription permanently.

This moves the subscription from Running to Stopped state.

pub async fn get_position( &self, ) -> SubscriptionResult<Option<SubscriptionPosition>>

Gets the current position of the subscription.

impl<E, S> TypedSubscription<E, Paused, S>

where E: Send + Sync + PartialEq + Eq + 'static, S: EventStore<Event = E>,

pub async fn resume( self, ) -> SubscriptionResult<TypedSubscription<E, Running, S>>

Resumes the subscription, continuing event processing from where it left off.

This moves the subscription from Paused to Running state.

pub async fn stop(self) -> SubscriptionResult<TypedSubscription<E, Stopped, S>>

Stops the subscription permanently.

This moves the subscription from Paused to Stopped state.

impl<E, S> TypedSubscription<E, Stopped, S>

where E: Send + Sync, S: EventStore<Event = E>,

pub const fn get_final_position(&self) -> Option<&SubscriptionPosition>

Gets the final position of the stopped subscription.

pub const fn name(&self) -> Option<&SubscriptionName>

Extracts the subscription name from a stopped subscription.

Trait Implementations

impl<E, State, S> Debug for TypedSubscription<E, State, S>

where E: Send + Sync, S: EventStore<Event = E>,

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

Formats the value using the given formatter.