Skip to main content

Projection

Struct Projection 

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

Projection definition: a set of handlers for a primary aggregate type.

A Projection is constructed without an aggregate id. Terminal operations:

§Example

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

// Start a subscription that keeps every aggregate up to date
let subscription = Projection::<_, AccountView>::new::<Account>()
    .handler(account_opened())
    .handler(money_deposited())
    .data(app_config)
    .subscription("account-view")
    .start(&executor)
    .await?;

Implementations§

Source§

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

Source

pub fn new<A: Aggregate>() -> Projection<E, P>

Creates a new projection definition for the given primary aggregate type.

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 strict(self) -> Self

Enables safety checks for unhandled events.

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

Source

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

Declares which event marks an aggregate as deleted (tombstoned).

When set:

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: AggregateEvent + 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 handler context.

Data added here is accessible in handlers via the context. Data lives on the projection definition and is reused for both Projection::load and Projection::subscription.

Source

pub fn load(self, id: impl Into<String>) -> LoadBuilder<E, P>

Returns a LoadBuilder for loading the aggregate with the given id.

Source

pub fn load_ids(self, ids: Vec<impl Into<String>>) -> LoadBuilder<E, P>

Returns a LoadBuilder for loading state keyed on multiple aggregate ids.

The ids are hashed via crate::hash_ids to produce a stable snapshot id.

Source

pub fn subscription( self, key: impl Into<String>, ) -> ProjectionSubscription<E, P>

Returns a builder for a subscription that keeps this projection up to date.

Auto Trait Implementations§

§

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

§

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

§

impl<E, P> Freeze 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> UnsafeUnpin 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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