StateT

StateT[F, S, A] is similar to Kleisli[F, S, A] in that it takes an S argument and produces an A value wrapped in F. However, it also produces an S value representing the updated state (which is wrapped in the F context along with the A value.

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Instance Constructors

new StateT(runF: F[(S) ⇒ F[(S, A)]])

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flatMap[B](fas: (A) ⇒ StateT[F, S, B])(implicit F: Monad[F]): StateT[F, S, B]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def inspect[B](f: (S) ⇒ B)(implicit F: Monad[F]): StateT[F, S, B]

Inspect a value from the input state, without modifying the state.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def map[B](f: (A) ⇒ B)(implicit F: Monad[F]): StateT[F, S, B]
def modify(f: (S) ⇒ S)(implicit F: Monad[F]): StateT[F, S, A]

Modify the state (S) component.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def run(initial: S)(implicit F: FlatMap[F]): F[(S, A)]

Run with the provided initial state value
def runA(s: S)(implicit F: FlatMap[F]): F[A]

Run with the provided initial state value and return the final value (discarding the final state).
def runEmpty(implicit S: Monoid[S], F: FlatMap[F]): F[(S, A)]

Run with S's empty monoid value as the initial state.
def runEmptyA(implicit S: Monoid[S], F: FlatMap[F]): F[A]

Run with S's empty monoid value as the initial state and return the final state (discarding the final value).
def runEmptyS(implicit S: Monoid[S], F: FlatMap[F]): F[S]

Run with S's empty monoid value as the initial state and return the final state (discarding the final value).
val runF: F[(S) ⇒ F[(S, A)]]
def runS(s: S)(implicit F: FlatMap[F]): F[S]

Run with the provided initial state value and return the final state (discarding the final value).
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transform[B](f: (S, A) ⇒ (S, B))(implicit F: Monad[F]): StateT[F, S, B]

Like map, but also allows the state (S) value to be modified.
def transformF[G[_], B](f: (F[(S, A)]) ⇒ G[(S, B)])(implicit F: FlatMap[F], G: Applicative[G]): StateT[G, S, B]

Like transform, but allows the context to change from F to G.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object StateT | package state

final class StateT[F[_], S, A] extends Serializable

Instance Constructors

new StateT(runF: F[(S) ⇒ F[(S, A)]])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def flatMap[B](fas: (A) ⇒ StateT[F, S, B])(implicit F: Monad[F]): StateT[F, S, B]

final def getClass(): Class[_]

def hashCode(): Int

def inspect[B](f: (S) ⇒ B)(implicit F: Monad[F]): StateT[F, S, B]

final def isInstanceOf[T0]: Boolean

def map[B](f: (A) ⇒ B)(implicit F: Monad[F]): StateT[F, S, B]

def modify(f: (S) ⇒ S)(implicit F: Monad[F]): StateT[F, S, A]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def run(initial: S)(implicit F: FlatMap[F]): F[(S, A)]

def runA(s: S)(implicit F: FlatMap[F]): F[A]

def runEmpty(implicit S: Monoid[S], F: FlatMap[F]): F[(S, A)]

def runEmptyA(implicit S: Monoid[S], F: FlatMap[F]): F[A]

def runEmptyS(implicit S: Monoid[S], F: FlatMap[F]): F[S]

val runF: F[(S) ⇒ F[(S, A)]]

def runS(s: S)(implicit F: FlatMap[F]): F[S]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def transform[B](f: (S, A) ⇒ (S, B))(implicit F: Monad[F]): StateT[F, S, B]

def transformF[G[_], B](f: (F[(S, A)]) ⇒ G[(S, B)])(implicit F: FlatMap[F], G: Applicative[G]): StateT[G, S, B]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped