Packages

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

A generalization of StoreT, where the underlying functor F has a Representable instance. Store is the dual of State

Source
RepresentableStore.scala
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])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. def coflatMap[B](f: (RepresentableStore[F, S, A]) ⇒ B): RepresentableStore[F, S, B]

    coflatMap is the dual of flatMap on FlatMap.

    coflatMap is the dual of flatMap on FlatMap. It applies a value in a context to a function that takes a value in a context and returns a normal value.

  7. lazy val coflatten: RepresentableStore[F, S, RepresentableStore[F, S, A]]

    coflatten is the dual of flatten on FlatMap.

    coflatten is the dual of flatten on FlatMap. Whereas flatten removes a layer of F, coflatten adds a layer of F

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def experiment[G[_]](fn: (S) ⇒ G[S])(implicit G: Functor[G]): G[A]

    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"))
  10. lazy val extract: A

    Extract the value at the current index.

  11. val fa: F[A]
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. val index: S
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def map[B](f: (A) ⇒ B): RepresentableStore[F, S, B]

    Functor map for RepresentableStore

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. def peek(s: S): A

    Peek at what the focus would be for a given focus s.

  20. def peeks(f: (S) ⇒ S): A

    Peek at what the focus would be if the current focus where transformed with the given function.

  21. def seek(s: S): RepresentableStore[F, S, A]

    Set the current focus.

  22. def seeks(f: (S) ⇒ S): RepresentableStore[F, S, A]

    Modify the current focus with the given function.

  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped