Skip to main content

Projection

Struct Projection 

Source
pub struct Projection<E: Executor, P: Default + 'static> { /* private fields */ }
Expand description

Projection for loading aggregate state from events.

Combines event handlers to rebuild aggregate state by replaying events. Supports snapshots for performance optimization.

§Example

let result = Projection::<_, AccountView>::new::<Account>("account-123")
    .handler(account_opened)
    .handler(money_deposited)
    .data(app_config)
    .execute(&executor)
    .await?;

Implementations§

Source§

impl<E: Executor, P: Snapshot<E> + Default + 'static> Projection<E, P>

Source

pub fn new<A: Aggregator>(id: impl Into<String>) -> Projection<E, P>
where P: Snapshot<E> + Default,

Creates a builder for loading aggregate state.

This consumes the projection and returns a [LoadBuilder] configured to load the state for the specified aggregate.

§Type Parameters
  • A: The aggregate type to load
Source

pub fn ids<A: Aggregator>(ids: Vec<impl Into<String>>) -> Projection<E, P>
where P: Snapshot<E> + Default,

Creates a builder for loading aggregate state.

This consumes the projection and returns a [LoadBuilder] configured to load the state for the specified aggregate.

§Type Parameters
  • A: The aggregate type to load
Source

pub fn revision(self, value: u16) -> Self

Sets the snapshot revision.

Changing the revision invalidates existing snapshots, forcing a full rebuild.

Source

pub fn safety_check(self) -> Self

Enables safety checks for unhandled events.

When enabled, execution fails if an event is encountered without a handler.

Source

pub fn handler<H: Handler<P> + 'static>(self, h: H) -> Self

Registers an event handler with this projection.

§Panics

Panics if a handler for the same event type is already registered.

Source

pub fn skip<EV: AggregatorEvent + Send + Sync + 'static>(self) -> Self

Registers a skip handler with this projection.

§Panics

Panics if a handler for the same event type is already registered.

Source

pub fn data<D: Send + Sync + 'static>(self, v: D) -> Self

Adds shared data to the load context.

Data added here is accessible in handlers via the context.

Source

pub fn aggregator<A: Aggregator>(self, id: impl Into<String>) -> Self

Adds a related aggregate to load events from.

Use this when the projection needs events from multiple aggregates.

Source

pub fn aggregator_raw( self, aggregator_type: impl Into<String>, id: impl Into<String>, ) -> Self

Adds a related aggregate to load events from.

Use this when the projection needs events from multiple aggregates.

Source

pub async fn execute(&self, executor: &E) -> Result<Option<P>>

Executes the load operation, returning the rebuilt state.

Returns None if no events exist for the aggregate. Returns Err if there are too many events to process in one batch.

Auto Trait Implementations§

§

impl<E, P> Freeze for Projection<E, P>

§

impl<E, P> !RefUnwindSafe for Projection<E, P>

§

impl<E, P> Send for Projection<E, P>

§

impl<E, P> Sync for Projection<E, P>

§

impl<E, P> Unpin for Projection<E, P>
where E: Unpin,

§

impl<E, P> !UnwindSafe for Projection<E, P>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more