Skip to main content

Effect

Struct Effect 

Source
pub struct Effect<C, E, S> { /* private fields */ }
Expand description

A command decision for an EventSourcedBehavior.

One main effect is followed by zero or more side effects. Side effects retain registration order and run only after the main effect completes successfully.

Implementations§

Source§

impl<C, E, S> Effect<C, E, S>

Source

pub fn persist(event: E) -> Self

Persists one event.

Source

pub fn persist_with_metadata( event: E, metadata: Option<SerializedPayload>, ) -> Self

Persists one event with an optional already-serialized metadata frame.

Source

pub fn persist_all(events: impl IntoIterator<Item = E>) -> Self

Persists all events as one all-or-nothing atomic journal write.

Source

pub fn persist_all_with_metadata( events: impl IntoIterator<Item = (E, Option<SerializedPayload>)>, ) -> Self

Persists all events and metadata as one all-or-nothing atomic journal write.

Source

pub fn none() -> Self

Handles the command without changing persistent state.

Source

pub fn unhandled() -> Self

Marks the command unhandled without changing persistent state.

Source

pub fn stop() -> Self

Stops the behavior after processing the command.

Source

pub fn stash(command: C) -> Self

Places an owned command in the bounded in-memory manual stash.

Datum handlers consume commands so commands may own one-shot ReplyPort values. Passing the command explicitly preserves that ownership without imposing a Clone bound on the command type. If the stash is full, the command is dropped and chained side effects are not run because the main effect did not succeed.

Source

pub fn unstash_all() -> Self

Starts draining the commands that were manually stashed at this point.

Source

pub fn reply<R>(reply_to: ReplyPort<R>, reply: R) -> ReplyEffect<C, E, S>
where R: Send + 'static,

Replies immediately after a successful no-persist effect.

Source

pub fn no_reply() -> ReplyEffect<C, E, S>

Explicitly chooses not to reply in an enforced-replies handler.

Source

pub fn async_effect<F>(future: F) -> Self
where F: Future<Output = Self> + Send + 'static,

Defers the command decision to an asynchronous computation.

This is the Rust-native spelling of Akka’s Effect.async; Akka readers can treat async_effect as its direct behavioral alias.

Source

pub fn async_reply<F>(future: F) -> ReplyEffect<C, E, S>
where C: Send + 'static, E: Send + 'static, S: Send + 'static, F: Future<Output = ReplyEffect<C, E, S>> + Send + 'static,

Defers an enforced-replies decision to an asynchronous computation.

Source

pub fn then_run<F>(self, callback: F) -> Self
where F: FnOnce(&S) + Send + 'static,

Runs a callback with the resulting state.

Source

pub fn then_stop(self) -> Self

Stops the behavior after all earlier side effects have run.

Source

pub fn then_unstash_all(self) -> Self

Starts a bounded drain of the current manual stash after earlier side effects.

Source

pub fn then_reply<R, F>( self, reply_to: ReplyPort<R>, reply: F, ) -> ReplyEffect<C, E, S>
where R: Send + 'static, F: FnOnce(&S) -> R + Send + 'static,

Sends a reply computed from the resulting state.

Source

pub fn then_no_reply(self) -> ReplyEffect<C, E, S>

Explicitly records that this command will not reply.

Auto Trait Implementations§

§

impl<C, E, S> !RefUnwindSafe for Effect<C, E, S>

§

impl<C, E, S> !Sync for Effect<C, E, S>

§

impl<C, E, S> !UnwindSafe for Effect<C, E, S>

§

impl<C, E, S> Freeze for Effect<C, E, S>
where MainEffect<C, E, S>: Freeze, Vec<ChainedEffect<S>>: Freeze,

§

impl<C, E, S> Send for Effect<C, E, S>
where MainEffect<C, E, S>: Send, Vec<ChainedEffect<S>>: Send,

§

impl<C, E, S> Unpin for Effect<C, E, S>
where MainEffect<C, E, S>: Unpin, Vec<ChainedEffect<S>>: Unpin,

§

impl<C, E, S> UnsafeUnpin for Effect<C, E, S>
where MainEffect<C, E, S>: UnsafeUnpin, Vec<ChainedEffect<S>>: UnsafeUnpin,

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<S> IntoEventHandlerResult<S> for S

Source§

fn into_event_handler_result(self) -> Result<S, PersistenceError>

Converts this handler output into the runtime result.
Source§

impl<T> Message for T
where T: Any + Send + 'static,

Source§

fn from_boxed(m: BoxedMessage) -> Result<Self, BoxedDowncastErr>

Convert a BoxedMessage to this concrete type
Source§

fn box_message(self, pid: &ActorId) -> Result<BoxedMessage, BoxedDowncastErr>

Convert this message to a BoxedMessage
Source§

impl<T> State for T
where T: Any + Send + 'static,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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