Tyrian
API
Generated with
Tyrian/tyrian/Cmd

Cmd

tyrian.Cmd
See theCmd companion trait
object Cmd

Attributes

Companion
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Cmd.type

Members list

Type members

Classlikes

case class Batch[F[_], Msg](cmds: List[Cmd[F, Msg]]) extends Cmd[F, Msg]

Treat many commands as one

Treat many commands as one

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Cmd[F, Msg]
class Object
trait Matchable
class Any
Show all
object Batch

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Batch.type
case class Combine[F[_], Msg](cmd1: Cmd[F, Msg], cmd2: Cmd[F, Msg]) extends Cmd[F, Msg]

Merge two commands into a single one

Merge two commands into a single one

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Cmd[F, Msg]
class Object
trait Matchable
class Any
Show all
final case class Emit[Msg](msg: Msg) extends Cmd[Nothing, Msg]

Simply produces a message that will then be actioned.

Simply produces a message that will then be actioned.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Cmd[Nothing, Msg]
class Object
trait Matchable
class Any
Show all
case object None extends Cmd[Nothing, Nothing]

The empty command represents the absence of any command to perform

The empty command represents the absence of any command to perform

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Cmd[Nothing, Nothing]
class Object
trait Matchable
class Any
Show all
Self type
None.type
final case class Run[F[_], A, Msg](task: F[A], toMsg: A => Msg)(implicit evidence$3: Applicative[F]) extends Cmd[F, Msg]

Represents runnable concurrent task that produces a message

Represents runnable concurrent task that produces a message

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Cmd[F, Msg]
class Object
trait Matchable
class Any
Show all
object Run

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Run.type
final case class SideEffect[F[_], A](task: F[A])(implicit evidence$2: Sync[F]) extends Cmd[F, Nothing]

Runs a task that produces no message

Runs a task that produces no message

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Cmd[F, Nothing]
class Object
trait Matchable
class Any
Show all
object SideEffect

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
SideEffect.type

Value members

Concrete methods

def combineAll[F[_], A](list: List[Cmd[F, A]]): Cmd[F, A]
def emit[Msg](msg: Msg): Cmd[Nothing, Msg]
def emitAfterDelay[F[_] : Temporal, Msg](msg: Msg, delay: FiniteDuration): Cmd[F, Msg]
final def merge[F[_], Msg, LubMsg >: Msg](a: Cmd[F, Msg], b: Cmd[F, LubMsg]): Cmd[F, LubMsg]

Givens

Givens

given given_CanEqual_Cmd_Cmd: CanEqual[Cmd[_[_], _], Cmd[_[_], _]]
given given_Eq_Cmd[F[_] : Applicative, Msg : Eq](implicit evidence$4: Applicative[F], evidence$5: Eq[Msg], ev: Eq[F[Option[Msg]]]): given_Eq_Cmd[F, Msg]
given given_Functor_Cmd[F[_]]: given_Functor_Cmd[F]
given given_Monoid_Cmd[F[_], Msg]: given_Monoid_Cmd[F, Msg]
Generated with