p

proptics

package proptics

Source
package.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. proptics
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package data
  2. package indices
  3. package instances
  4. package internal
  5. package law
  6. package profunctor
  7. package rank2types
  8. package std
  9. package syntax
  10. package typeclass

Type Members

  1. type ALens[S, A] = ALens_[S, S, A, A]

    ALens is a specialization of ALens_

  2. abstract class ALens_[S, T, A, B] extends Serializable

    An ALens_ ] focuses a single piece of data within a larger structure.

    An ALens_ ] focuses a single piece of data within a larger structure.

    An ALens_ provides a convenient way to view, set, and transform that element.

    An ALens_ must never fail to get or modify that focus.

    An ALens_ is a Lens_ with fixed type proptics.internal.Shop cats.arrow.Profunctor

    S

    the source of a ALens_

    T

    the modified source of a ALens_

    A

    the focus of a ALens_

    B

    the modified focus of a ALens_

  3. type APrism[S, A] = APrism_[S, S, A, A]

    APrism is a specialization of APrism_

  4. abstract class APrism_[S, T, A, B] extends FoldCompat0[S, A]

    APrism_ is used for selecting cases of a type, most often a sum type.

    APrism_ is used for selecting cases of a type, most often a sum type.

    APrism_ is a Prism_ with fixed type proptics.internal.Market cats.arrow.Profunctor

    S

    the source of an APrism_

    T

    the modified source of an APrism_

    A

    the focus of an APrism_

    B

    the modified focus of an APrism_

  5. type ATraversal[S, A] = ATraversal_[S, S, A, A]

    ATraversal is a specialization of ATraversal_

  6. abstract class ATraversal_[S, T, A, B] extends FoldCompat[S, A]

    ATraversal_ is an optic that focuses on zero or more values.

    ATraversal_ is an optic that focuses on zero or more values.

    ATraversal_ is a Traversal_ with fixed type proptics.internal.Bazaar cats.arrow.Profunctor

    S

    the source of a ATraversal_

    T

    the modified source of a ATraversal_

    A

    the foci of a ATraversal_

    B

    the modified foci of a ATraversal_

  7. type AffineTraversal[S, A] = AffineTraversal_[S, S, A, A]

    AffineTraversal is a specialization of AffineTraversal_

  8. abstract class AffineTraversal_[S, T, A, B] extends FoldCompat0[S, A]

    AffineTraversal_ has at most one focus, but is not a Prism_

    AffineTraversal_ has at most one focus, but is not a Prism_

    S

    the source of an AffineTraversal_

    T

    the modified source of an AffineTraversal_

    A

    the focus of an AffineTraversal_

    B

    the modified focus of an AffineTraversal_

  9. type AnAffineTraversal[S, A] = AnAffineTraversal_[S, S, A, A]

    AffineTraversal is a specialization of AffineTraversal_

  10. abstract class AnAffineTraversal_[S, T, A, B] extends FoldCompat0[S, A]

    AnAffineTraversal_ has at most one focus, but is not a Prism_.

    S

    the source of an AnAffineTraversal_

    T

    the modified source of an AnAffineTraversal_

    A

    the focus of an AnAffineTraversal_

    B

    the modified focus of an AnAffineTraversal_

  11. type AnIndexedLens[I, S, A] = AnIndexedLens_[I, S, S, A, A]

    AnIndexedLens is a specialization of AnIndexedLens_

  12. abstract class AnIndexedLens_[I, S, T, A, B] extends AnyRef

    An AnIndexedLens_ ] focuses a single piece of data and index within a larger structure.

    An AnIndexedLens_ ] focuses a single piece of data and index within a larger structure.

    An AnIndexedLens_ provides a convenient way to view, set, and transform that element.

    An AnIndexedLens_ must never fail to get or modify that focus.

    an AnIndexedLens_ is an IndexedLens_ with fixed type proptics.internal.Shop cats.arrow.Profunctor

    I

    the index of an AnIndexedLens_

    S

    the source of an AnIndexedLens_

    T

    the modified source of an AnIndexedLens_

    A

    the focus of an AnIndexedLens_

    B

    the modified focus of an AnIndexedLens_

  13. type AnIso[S, A] = AnIso_[S, S, A, A]

    AnIso is a specialization of AnIso_

  14. abstract class AnIso_[S, T, A, B] extends AnyRef

    An AnIso_ is a generalized isomorphism.

    An AnIso_ is a generalized isomorphism.

    An AnIso_ is a complete reversible transformation between two types.

    An AnIso_ is an Iso_ with fixed type proptics.internal.Exchange cats.arrow.Profunctor

    S

    the source of a AnIso_

    T

    the modified source of an AnIso_

    A

    the focus of an AnIso_

    B

    the modified focus of an AnIso_

  15. type Fold[S, A] = Fold_[S, S, A, A]

    Fold is a specialization of Fold_

  16. trait FoldCompat[S, A] extends FoldCompat0[S, A]
  17. trait FoldCompat0[S, A] extends Serializable
  18. abstract class Fold_[S, T, A, B] extends FoldCompat[S, A]

    A Fold_ is a generalization of something Foldable.

    A Fold_ is a generalization of something Foldable. It describes how to retrieve multiple values.

    A Fold_ is similar to a Traversal_, but it cannot modify its foci.

    A Fold_ is an Optic with fixed type proptics.internal.Forget cats.arrow.Profunctor

    S

    the source of a Fold_

    T

    the modified source of a Fold_

    A

    the foci of a Fold_

    B

    the modified foci of a Fold_

  19. type Getter[S, A] = Getter_[S, S, A, A]

    Getter is a specialization of Getter_

  20. abstract class Getter_[S, T, A, B] extends Serializable

    A Getter_ is a Fold_ without a cats.Monoid.

    A Getter_ is a Fold_ without a cats.Monoid.

    A Getter_ is just any get function (S -> A)

    S

    the source of a Getter_

    T

    the modified source of a Getter_

    A

    the focus of a Getter_

    B

    the modified focus of a Getter_

  21. type Grate[S, A] = Grate_[S, S, A, A]

    Grate is a specialization of Grate_

  22. abstract class Grate_[S, T, A, B] extends AnyRef

    A Grate_ allows a generalized zipWith operation.

    A Grate_ allows a generalized zipWith operation.

    S

    the source of a Grate_

    T

    the modified source of a Grate_

    A

    the focus of a Grate_

    B

    the modified focus of a Grate_

  23. type IndexedFold[I, S, A] = IndexedFold_[I, S, S, A, A]

    IndexedFold is a specialization of IndexedFold_

  24. trait IndexedFoldCompat[S, I, A] extends Serializable
  25. abstract class IndexedFold_[I, S, T, A, B] extends IndexedFoldCompat[S, I, A]

    A IndexedFold_ is a generalization of something Foldable.

    A IndexedFold_ is a generalization of something Foldable. It describes how to retrieve multiple values and thier indices.

    A IndexedFold_ is similar to a IndexedTraversal_, but it cannot modify its foci.

    An IndexedFold_ is an indexed optic with fixed type proptics.internal.Forget cats.arrow.Profunctor

    I

    the index of an IndexedFold_

    S

    the source of an IndexedFold_

    T

    the modified source of an IndexedFold_

    A

    the foci of an IndexedFold_

    B

    the modified foci of an IndexedFold_

  26. type IndexedGetter[I, S, A] = IndexedGetter_[I, S, S, A, A]

    IndexedGetter is a specialization of IndexedGetter_

  27. abstract class IndexedGetter_[I, S, T, A, B] extends Serializable

    An IndexedGetter_ is an IndexedFold_ without a cats.Monoid.

    An IndexedGetter_ is an IndexedFold_ without a cats.Monoid.

    An IndexedGetter_ is just any get function (S -> (A, I))

    I

    the index of an IndexedGetter_

    S

    the source of an IndexedGetter_

    T

    the modified source of an IndexedGetter_

    A

    the focus of an IndexedGetter_

    B

    the modified focus of an IndexedGetter_

  28. type IndexedLens[I, S, A] = IndexedLens_[I, S, S, A, A]

    IndexedLens is a specialization of IndexedLens_

  29. abstract class IndexedLens_[I, S, T, A, B] extends Serializable

    An IndexedLens_ ] focuses a single piece of data and index within a larger structure.

    An IndexedLens_ ] focuses a single piece of data and index within a larger structure.

    An IndexedLens_ provides a convenient way to view, set, and transform that element.

    An IndexedLens_ must never fail to get or modify that focus.

    I

    the index of an IndexedLens_

    S

    the source of an IndexedLens_

    T

    the modified source of an IndexedLens_

    A

    the focus of an IndexedLens_

    B

    the modified focus of an IndexedLens_

  30. type IndexedSetter[I, S, A] = IndexedSetter_[I, S, S, A, A]

    IndexedSetter is a specialization of IndexedSetter_

  31. abstract class IndexedSetter_[I, S, T, A, B] extends Serializable

    An IndexedSetter_ is a generalization of mapWithIndex from proptics.indices.FunctorWithIndex

    An IndexedSetter_ is a generalization of mapWithIndex from proptics.indices.FunctorWithIndex

    I

    the index of an IndexedSetter_

    S

    the source of an IndexedSetter_

    T

    the modified source of an IndexedSetter_

    A

    the focus an IndexedSetter_

    B

    the modified focus of an IndexedSetter_

  32. type IndexedTraversal[I, S, A] = IndexedTraversal_[I, S, S, A, A]

    IndexedTraversal is a specialization of IndexedTraversal_

  33. abstract class IndexedTraversal_[I, S, T, A, B] extends IndexedFoldCompat[S, I, A]

    An IndexedTraversal_ is an indexed optic that focuses on zero or more values, and their indices.

    An IndexedTraversal_ is an indexed optic that focuses on zero or more values, and their indices.

    I

    the index of an IndexedTraversal_

    S

    the source of an IndexedTraversal_

    T

    the modified source of an IndexedTraversal_

    A

    the foci of an IndexedTraversal_

    B

    the modified foci of an IndexedTraversal_

  34. type Iso[S, A] = Iso_[S, S, A, A]

    Iso is a specialization of Iso_

  35. abstract class Iso_[S, T, A, B] extends Serializable

    An Iso_ is a generalized isomorphism.

    An Iso_ is a generalized isomorphism.

    An Iso_ is a complete reversible transformation between two types.

    S

    the source of an Iso_

    T

    the modified source of an Iso_

    A

    the focus of an Iso_

    B

    the modified focus of a Iso_

  36. type Lens[S, A] = Lens_[S, S, A, A]

    Lens is a specialization of Lens_

  37. abstract class Lens_[S, T, A, B] extends Serializable

    A Lens_ ] focuses a single piece of data within a larger structure.

    A Lens_ ] focuses a single piece of data within a larger structure.

    A Lens_ provides a convenient way to view, set, and transform that element.

    A Lens_ must never fail to get or modify that focus.

    S

    the source of a Lens_

    T

    the modified source of a Lens_

    A

    the focus of a Lens_

    B

    the modified focus of a Lens_

  38. type Prism[S, A] = Prism_[S, S, A, A]

    Prism is a specialization of Prism_

  39. abstract class Prism_[S, T, A, B] extends FoldCompat0[S, A]

    A Prism_ is used for selecting cases of a type, most often a sum type.

    A Prism_ is used for selecting cases of a type, most often a sum type.

    A Prism_ can fail to get or modify its focus.

    A Prism_ can only focus at most one value.

    S

    the source of a Prism_

    T

    the modified source of a Prism_

    A

    the focus of a Prism_

    B

    the modified focus of a Prism_

  40. type Review[S, A] = Review_[S, S, A, A]

    Review is a specialization of Review_

  41. abstract class Review_[S, T, A, B] extends Serializable

    A Review_ describes how to construct a single value.

    A Review_ describes how to construct a single value. It's a dual of Getter_.

    A Review_ is isomorphic to an arbitrary function from (B -> T)

    S

    the source of a Review_

    T

    the modified source of a Review_

    A

    the focus of a Review_

    B

    the modified focus of a Review_

  42. type Setter[S, A] = Setter_[S, S, A, A]

    Setter is a specialization of Setter_

  43. abstract class Setter_[S, T, A, B] extends Serializable

    A Setter_ is a generalization of map from cats.Functor

    A Setter_ is a generalization of map from cats.Functor

    S

    the source of a Setter_

    T

    the modified source of a Setter_ ß

    A

    the focus of a Setter_

    B

    the modified focus of a Setter_

  44. type Traversal[S, A] = Traversal_[S, S, A, A]

    Traversal is a specialization of Traversal_

  45. abstract class Traversal_[S, T, A, B] extends FoldCompat[S, A]

    A Traversal_ is an optic that focuses on zero or more values

    A Traversal_ is an optic that focuses on zero or more values

    S

    the source of a Traversal_

    T

    the modified source of a Traversal_

    A

    the foci of a Traversal_

    B

    the modified foci of a Traversal_

Value Members

  1. object ALens
  2. object ALens_ extends Serializable
  3. object APrism
  4. object APrism_ extends Serializable
  5. object ATraversal
  6. object ATraversal_ extends Serializable
  7. object AffineTraversal
  8. object AffineTraversal_ extends Serializable
  9. object AnAffineTraversal
  10. object AnAffineTraversal_ extends Serializable
  11. object AnIndexedLens
  12. object AnIndexedLens_
  13. object AnIso
  14. object AnIso_
  15. object Fold
  16. object Fold_ extends Serializable
  17. object Getter
  18. object Getter_ extends Serializable
  19. object Grate
  20. object Grate_
  21. object IndexedFold
  22. object IndexedFold_ extends Serializable
  23. object IndexedGetter
  24. object IndexedGetter_ extends Serializable
  25. object IndexedLens
  26. object IndexedLens_ extends Serializable
  27. object IndexedSetter
  28. object IndexedSetter_ extends Serializable
  29. object IndexedTraversal
  30. object IndexedTraversal_ extends Serializable
  31. object Iso
  32. object Iso_ extends Serializable
  33. object Lens
  34. object Lens2
  35. object Lens3
  36. object Lens4
  37. object Lens5
  38. object Lens_ extends Serializable
  39. object Prism
  40. object Prism_ extends Serializable
  41. object Review
  42. object Review_ extends Serializable
  43. object Setter
  44. object Setter_ extends Serializable
  45. object Traversal
  46. object Traversal2
  47. object Traversal3
  48. object Traversal4
  49. object Traversal5
  50. object Traversal_ extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped