Packages

trait EffectBuilder[+Event, State] extends Effect[Event, State]

A command handler returns an Effect directive that defines what event or events to persist.

Instances are created through the factories in the Effect companion object.

Additional side effects can be performed in the callback thenRun

Not for user extension.

Annotations
@DoNotInherit()
Source
Effect.scala
Linear Supertypes
Effect[Event, State], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EffectBuilder
  2. Effect
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def events: Seq[Event]
  2. abstract def thenNoReply(): ReplyEffect[Event, State]

    When EventSourcedBehavior.withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect.

    When EventSourcedBehavior.withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. This thenNoReply can be used as a conscious decision that a reply shouldn't be sent for a specific command or the reply will be sent later.

  3. abstract def thenReply[ReplyMessage](replyTo: ActorRef[ReplyMessage])(replyWithMessage: (State) => ReplyMessage): ReplyEffect[Event, State]

    Send a reply message to the command.

    Send a reply message to the command. The type of the reply message must conform to the type specified by the passed replyTo ActorRef.

    This has the same semantics as replyTo.tell.

    It is provided as a convenience (reducing boilerplate) and a way to enforce that replies are not forgotten when the EventSourcedBehavior is created with EventSourcedBehavior.withEnforcedReplies. When withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. The reply message will be sent also if withEnforcedReplies isn't used, but then the compiler will not help finding mistakes.

  4. abstract def thenRun(callback: (State) => Unit): EffectBuilder[Event, State]

    Run the given callback.

    Run the given callback. Callbacks are run sequentially.

  5. abstract def thenStop(): EffectBuilder[Event, State]

    The side effect is to stop the actor

  6. abstract def thenUnstashAll(): Effect[Event, State]

    Unstash the commands that were stashed with Effect.stash.

    Unstash the commands that were stashed with Effect.stash.

    It's allowed to stash messages while unstashing. Those newly added commands will not be processed by this unstashAll effect and have to be unstashed by another unstashAll.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EffectBuilder[Event, State] toany2stringadd[EffectBuilder[Event, State]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EffectBuilder[Event, State], B)
    Implicit
    This member is added by an implicit conversion from EffectBuilder[Event, State] toArrowAssoc[EffectBuilder[Event, State]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (EffectBuilder[Event, State]) => Boolean, msg: => Any): EffectBuilder[Event, State]
    Implicit
    This member is added by an implicit conversion from EffectBuilder[Event, State] toEnsuring[EffectBuilder[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (EffectBuilder[Event, State]) => Boolean): EffectBuilder[Event, State]
    Implicit
    This member is added by an implicit conversion from EffectBuilder[Event, State] toEnsuring[EffectBuilder[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): EffectBuilder[Event, State]
    Implicit
    This member is added by an implicit conversion from EffectBuilder[Event, State] toEnsuring[EffectBuilder[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): EffectBuilder[Event, State]
    Implicit
    This member is added by an implicit conversion from EffectBuilder[Event, State] toEnsuring[EffectBuilder[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EffectBuilder[Event, State] toStringFormat[EffectBuilder[Event, State]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (EffectBuilder[Event, State], B)
    Implicit
    This member is added by an implicit conversion from EffectBuilder[Event, State] toArrowAssoc[EffectBuilder[Event, State]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Effect[Event, State]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEffectBuilder[Event, State] to any2stringadd[EffectBuilder[Event, State]]

Inherited by implicit conversion StringFormat fromEffectBuilder[Event, State] to StringFormat[EffectBuilder[Event, State]]

Inherited by implicit conversion Ensuring fromEffectBuilder[Event, State] to Ensuring[EffectBuilder[Event, State]]

Inherited by implicit conversion ArrowAssoc fromEffectBuilder[Event, State] to ArrowAssoc[EffectBuilder[Event, State]]

Ungrouped