Class/Object

cats.data

RepresentableStore

Related Docs: object RepresentableStore | package data

Permalink

final case class RepresentableStore[F[_], S, A](fa: F[A], index: S)(implicit R: Aux[F, S]) extends Product with Serializable

A generalisation of the Store comonad, for any Representable functor. Store is the dual of State

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RepresentableStore
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RepresentableStore(fa: F[A], index: S)(implicit R: Aux[F, S])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. lazy val coflatten: RepresentableStore[F, S, RepresentableStore[F, S, A]]

    Permalink

    Duplicate the store structure

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def experiment[G[_]](fn: (S) ⇒ G[S])(implicit G: Functor[G]): G[A]

    Permalink

    Given a functorial computation on the index S peek at the value in that functor.

    Given a functorial computation on the index S peek at the value in that functor.

    import cats._, implicits._, data.Store
    
    val initial = List("a", "b", "c")
    val store = Store(idx => initial.get(idx).getOrElse(""), 0)
    val adjacent = store.experiment[List] { idx => List(idx - 1, idx, idx + 1) }
    
    require(adjacent == List("", "a", "b"))
  9. lazy val extract: A

    Permalink

    Extract the value at the current index.

  10. val fa: F[A]

    Permalink
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. val index: S

    Permalink
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. def map[B](f: (A) ⇒ B): RepresentableStore[F, S, B]

    Permalink
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def peek(s: S): A

    Permalink

    Inspect the value at "index" s

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

    Permalink
    Definition Classes
    AnyRef
  21. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped