trait EffectBuilder[+State] extends Effect[State]
A command handler returns an Effect
directive that defines what state 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
- Alphabetic
- By Inheritance
- EffectBuilder
- Effect
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def state: Option[State]
- abstract def thenNoReply(): ReplyEffect[State]
When DurableStateBehavior.withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect.
When DurableStateBehavior.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. - abstract def thenReply[ReplyMessage](replyTo: ActorRef[ReplyMessage])(replyWithMessage: (State) => ReplyMessage): ReplyEffect[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
DurableStateBehavior
is created with DurableStateBehavior.withEnforcedReplies. WhenwithEnforcedReplies
is used there will be compilation errors if the returned effect isn't a ReplyEffect. The reply message will be sent also ifwithEnforcedReplies
isn't used, but then the compiler will not help finding mistakes. - abstract def thenRun(callback: (State) => Unit): EffectBuilder[State]
Run the given callback.
Run the given callback. Callbacks are run sequentially.
- abstract def thenStop(): EffectBuilder[State]
The side effect is to stop the actor
- abstract def thenUnstashAll(): Effect[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 anotherunstashAll
.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from EffectBuilder[State] toany2stringadd[EffectBuilder[State]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (EffectBuilder[State], B)
- Implicit
- This member is added by an implicit conversion from EffectBuilder[State] toArrowAssoc[EffectBuilder[State]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (EffectBuilder[State]) => Boolean, msg: => Any): EffectBuilder[State]
- Implicit
- This member is added by an implicit conversion from EffectBuilder[State] toEnsuring[EffectBuilder[State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (EffectBuilder[State]) => Boolean): EffectBuilder[State]
- Implicit
- This member is added by an implicit conversion from EffectBuilder[State] toEnsuring[EffectBuilder[State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): EffectBuilder[State]
- Implicit
- This member is added by an implicit conversion from EffectBuilder[State] toEnsuring[EffectBuilder[State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): EffectBuilder[State]
- Implicit
- This member is added by an implicit conversion from EffectBuilder[State] toEnsuring[EffectBuilder[State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from EffectBuilder[State] toStringFormat[EffectBuilder[State]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (EffectBuilder[State], B)
- Implicit
- This member is added by an implicit conversion from EffectBuilder[State] toArrowAssoc[EffectBuilder[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.