Proptics core/proptics/IndexedLens_

IndexedLens_

abstract class IndexedLens_[I, S, T, A, B] extends IndexedLens0[I, S, T, A, B]

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.

Type parameters:
A

the focus of an IndexedLens_

B

the modified focus of an IndexedLens_

I

the index of an IndexedLens_

S

the source of an IndexedLens_

T

the modified source of an IndexedLens_

Companion:
object
trait IndexedLens0[I, S, T, A, B]
trait IndexedGetter1[I, S, A]
trait IndexedGetter0[I, S, A]
trait IndexedTraversal0[I, S, T, A, B]
trait IndexedSetter0[I, S, T, A, B]
class Object
trait Matchable
class Any
IndexedLens_[I, S, T, A, B]

Value members

Concrete methods

final def *>>[J, C, D](other: IndexedLens_[J, A, B, C, D]): IndexedLens_[J, S, T, C, D]

compose this IndexedLens_ with an IndexedLens_, while preserving the indices of the other optic

compose this IndexedLens_ with an IndexedLens_, while preserving the indices of the other optic

final def *>>[J, C, D](other: AnIndexedLens_[J, A, B, C, D]): AnIndexedLens_[J, S, T, C, D]

compose this IndexedLens_ with an AnIndexedLens_, while preserving the indices of the other optic

compose this IndexedLens_ with an AnIndexedLens_, while preserving the indices of the other optic

final def *>>[J, C, D](other: IndexedTraversal_[J, A, B, C, D]): IndexedTraversal_[J, S, T, C, D]

compose this IndexedLens_ with an IndexedTraversal_, while preserving the indices of the other optic

compose this IndexedLens_ with an IndexedTraversal_, while preserving the indices of the other optic

final def *>>[J, C, D](other: IndexedSetter_[J, A, B, C, D]): IndexedSetter_[J, S, T, C, D]

compose this IndexedLens_ with an IndexedSetter_, while preserving the indices of the other optic

compose this IndexedLens_ with an IndexedSetter_, while preserving the indices of the other optic

final def *>>[J, C, D](other: IndexedGetter_[J, A, B, C, D]): IndexedGetter_[J, S, T, C, D]

compose this IndexedLens_ with an IndexedGetter_, while preserving the indices of the other optic

compose this IndexedLens_ with an IndexedGetter_, while preserving the indices of the other optic

final def *>>[J, C, D](other: IndexedFold_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose this IndexedLens_ with an IndexedFold_, while preserving the indices of the other optic

compose this IndexedLens_ with an IndexedFold_, while preserving the indices of the other optic

final def <<*[C, D](other: IndexedLens_[_, A, B, C, D]): IndexedLens_[I, S, T, C, D]

compose this IndexedLens_ with an IndexedLens_, while preserving self indices

compose this IndexedLens_ with an IndexedLens_, while preserving self indices

final def <<*[C, D](other: AnIndexedLens_[_, A, B, C, D]): AnIndexedLens_[I, S, T, C, D]

compose this IndexedLens_ with an AnIndexedLens_, while preserving self indices

compose this IndexedLens_ with an AnIndexedLens_, while preserving self indices

final def <<*[J, C, D](other: IndexedTraversal_[_, A, B, C, D]): IndexedTraversal_[I, S, T, C, D]

compose this IndexedLens_ with an IndexedTraversal_, while preserving self indices

compose this IndexedLens_ with an IndexedTraversal_, while preserving self indices

final def <<*[J, C, D](other: IndexedSetter_[_, A, B, C, D]): IndexedSetter_[I, S, T, C, D]

compose this IndexedLens_ with an IndexedSetter_, while preserving self indices

compose this IndexedLens_ with an IndexedSetter_, while preserving self indices

final def <<*[J, C, D](other: IndexedGetter_[_, A, B, C, D]): IndexedGetter_[I, S, T, C, D]

compose this IndexedLens_ with an IndexedGetter_, while preserving self indices

compose this IndexedLens_ with an IndexedGetter_, while preserving self indices

final def <<*[J, C, D](other: IndexedFold_[_, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedLens_ with an IndexedFold_, while preserving self indices

compose this IndexedLens_ with an IndexedFold_, while preserving self indices

final def andThen[C, D](other: Iso_[A, B, C, D]): IndexedLens_[I, S, T, C, D]

compose this IndexedLens_ with an Iso_, having this IndexedLens_ applied first

compose this IndexedLens_ with an Iso_, having this IndexedLens_ applied first

final def andThen[C, D](other: AnIso_[A, B, C, D]): IndexedLens_[I, S, T, C, D]

compose this IndexedLens_ with an AnIso_, having this IndexedLens_ applied first

compose this IndexedLens_ with an AnIso_, having this IndexedLens_ applied first

final def andThen[C, D](other: Lens_[A, B, C, D]): IndexedLens_[I, S, T, C, D]

compose this IndexedLens_ with a Lens_, having this IndexedLens_ applied first

compose this IndexedLens_ with a Lens_, having this IndexedLens_ applied first

final def andThen[C, D](other: ALens_[A, B, C, D]): IndexedLens_[I, S, T, C, D]

compose this IndexedLens_ with an ALens_, having this IndexedLens_ applied first

compose this IndexedLens_ with an ALens_, having this IndexedLens_ applied first

final def andThen[C, D](other: Prism_[A, B, C, D]): IndexedTraversal_[I, S, T, C, D]

compose this IndexedLens_ with a Prism_, having this IndexedLens_ applied first

compose this IndexedLens_ with a Prism_, having this IndexedLens_ applied first

final def andThen[C, D](other: APrism_[A, B, C, D]): IndexedTraversal_[I, S, T, C, D]

compose this IndexedLens_ with an APrism_, having this IndexedLens_ applied first

compose this IndexedLens_ with an APrism_, having this IndexedLens_ applied first

final def andThen[C, D](other: AffineTraversal_[A, B, C, D]): IndexedTraversal_[I, S, T, C, D]

compose this IndexedLens_ with an AffineTraversal_, having this IndexedLens_ applied first

compose this IndexedLens_ with an AffineTraversal_, having this IndexedLens_ applied first

final def andThen[C, D](other: AnAffineTraversal_[A, B, C, D]): IndexedTraversal_[I, S, T, C, D]

compose this IndexedLens_ with an AnAffineTraversal_, having this IndexedLens_ applied first

compose this IndexedLens_ with an AnAffineTraversal_, having this IndexedLens_ applied first

final def andThen[C, D](other: Traversal_[A, B, C, D]): IndexedTraversal_[I, S, T, C, D]

compose this IndexedLens_ with a Traversal_, having this IndexedLens_ applied first

compose this IndexedLens_ with a Traversal_, having this IndexedLens_ applied first

final def andThen[C, D](other: ATraversal_[A, B, C, D]): IndexedTraversal_[I, S, T, C, D]

compose this IndexedLens_ with an ATraversal_, having this IndexedLens_ applied first

compose this IndexedLens_ with an ATraversal_, having this IndexedLens_ applied first

final def andThen[C, D](other: Setter_[A, B, C, D]): IndexedSetter_[I, S, T, C, D]

compose an IndexedTraversal_ with a Setter_, having this IndexedLens_ applied first

compose an IndexedTraversal_ with a Setter_, having this IndexedLens_ applied first

final def andThen[C, D](other: Getter_[A, B, C, D]): IndexedGetter_[I, S, T, C, D]

compose an IndexedTraversal_ with a Getter_, having this IndexedLens_ applied first

compose an IndexedTraversal_ with a Getter_, having this IndexedLens_ applied first

final def andThen[C, D](other: Fold_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose an IndexedTraversal_ with a Fold_, having this IndexedLens_ applied first

compose an IndexedTraversal_ with a Fold_, having this IndexedLens_ applied first

final def andThenWithLeftIndex[C, D](other: IndexedLens_[_, A, B, C, D]): IndexedLens_[I, S, T, C, D]

compose this IndexedLens_ with an IndexedLens_, while preserving self indices

compose this IndexedLens_ with an IndexedLens_, while preserving self indices

final def andThenWithLeftIndex[C, D](other: AnIndexedLens_[_, A, B, C, D]): AnIndexedLens_[I, S, T, C, D]

compose this IndexedLens_ with an AnIndexedLens_, while preserving self indices

compose this IndexedLens_ with an AnIndexedLens_, while preserving self indices

final def andThenWithLeftIndex[C, D](other: IndexedTraversal_[_, A, B, C, D]): IndexedTraversal_[I, S, T, C, D]

compose this IndexedLens_ with an IndexedTraversal_, while preserving self indices

compose this IndexedLens_ with an IndexedTraversal_, while preserving self indices

final def andThenWithLeftIndex[J, C, D](other: IndexedSetter_[_, A, B, C, D]): IndexedSetter_[I, S, T, C, D]

compose this IndexedLens_ with an IndexedSetter_, while preserving self indices

compose this IndexedLens_ with an IndexedSetter_, while preserving self indices

final def andThenWithLeftIndex[J, C, D](other: IndexedGetter_[_, A, B, C, D]): IndexedGetter_[I, S, T, C, D]

compose this IndexedLens_ with an IndexedGetter_, while preserving self indices

compose this IndexedLens_ with an IndexedGetter_, while preserving self indices

final def andThenWithLeftIndex[C, D](other: IndexedFold_[_, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedLens_ with an IndexedFold_, while preserving self indices

compose this IndexedLens_ with an IndexedFold_, while preserving self indices

final def andThenWithRightIndex[J, C, D](other: IndexedLens_[J, A, B, C, D]): IndexedLens_[J, S, T, C, D]

compose this IndexedLens_ with an IndexedLens_, while preserving the indices of the other optic

compose this IndexedLens_ with an IndexedLens_, while preserving the indices of the other optic

final def andThenWithRightIndex[J, C, D](other: AnIndexedLens_[J, A, B, C, D]): AnIndexedLens_[J, S, T, C, D]

compose this IndexedLens_ with an AnIndexedLens_, while preserving the indices of the other optic

compose this IndexedLens_ with an AnIndexedLens_, while preserving the indices of the other optic

final def andThenWithRightIndex[J, C, D](other: IndexedTraversal_[J, A, B, C, D]): IndexedTraversal_[J, S, T, C, D]

compose this IndexedLens_ with an IndexedTraversal_, while preserving the indices of the other optic

compose this IndexedLens_ with an IndexedTraversal_, while preserving the indices of the other optic

final def andThenWithRightIndex[J, C, D](other: IndexedSetter_[J, A, B, C, D]): IndexedSetter_[J, S, T, C, D]

compose this IndexedLens_ with an IndexedSetter_, while preserving the indices of the other optic

compose this IndexedLens_ with an IndexedSetter_, while preserving the indices of the other optic

final def andThenWithRightIndex[J, C, D](other: IndexedGetter_[J, A, B, C, D]): IndexedGetter_[J, S, T, C, D]

compose this IndexedLens_ with an IndexedGetter_, while preserving the indices of the other optic

compose this IndexedLens_ with an IndexedGetter_, while preserving the indices of the other optic

final def andThenWithRightIndex[J, C, D](other: IndexedFold_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose this IndexedLens_ with an IndexedFold_, while preserving the indices of the other optic

compose this IndexedLens_ with an IndexedFold_, while preserving the indices of the other optic

final def asIndexedFold: IndexedFold_[I, S, T, A, B]

transform an IndexedLens_ to an IndexedFold_

transform an IndexedLens_ to an IndexedFold_

final def asLens: Lens_[S, T, A, B]

transform an IndexedLens_ to a Lens_

transform an IndexedLens_ to a Lens_

final def compose[C, D](other: Iso_[C, D, S, T]): IndexedLens_[I, C, D, A, B]

compose this IndexedLens_ with an Iso_, having this IndexedLens_ applied last

compose this IndexedLens_ with an Iso_, having this IndexedLens_ applied last

final def compose[C, D](other: AnIso_[C, D, S, T]): IndexedLens_[I, C, D, A, B]

compose this IndexedLens_ with an AnIso_, having this IndexedLens_ applied last

compose this IndexedLens_ with an AnIso_, having this IndexedLens_ applied last

final def compose[C, D](other: Lens_[C, D, S, T]): IndexedLens_[I, C, D, A, B]

compose this IndexedLens_ with a Lens_, having this IndexedLens_ applied last

compose this IndexedLens_ with a Lens_, having this IndexedLens_ applied last

final def compose[C, D](other: ALens_[C, D, S, T]): IndexedLens_[I, C, D, A, B]

compose this IndexedLens_ with an ALens_, having this IndexedLens_ applied last

compose this IndexedLens_ with an ALens_, having this IndexedLens_ applied last

final def compose[C, D](other: Prism_[C, D, S, T]): IndexedTraversal_[I, C, D, A, B]

compose this IndexedLens_ with a Prism_, having this IndexedLens_ applied last

compose this IndexedLens_ with a Prism_, having this IndexedLens_ applied last

final def compose[C, D](other: APrism_[C, D, S, T]): IndexedTraversal_[I, C, D, A, B]

compose this IndexedLens_ with an APrism_, having this IndexedLens_ applied last

compose this IndexedLens_ with an APrism_, having this IndexedLens_ applied last

final def compose[C, D](other: AffineTraversal_[C, D, S, T]): IndexedTraversal_[I, C, D, A, B]

compose this IndexedLens_ with an AffineTraversal_, having this IndexedLens_ applied last

compose this IndexedLens_ with an AffineTraversal_, having this IndexedLens_ applied last

final def compose[C, D](other: AnAffineTraversal_[C, D, S, T]): IndexedTraversal_[I, C, D, A, B]

compose this IndexedLens_ with an AnAffineTraversal_, having this IndexedLens_ applied last

compose this IndexedLens_ with an AnAffineTraversal_, having this IndexedLens_ applied last

final def compose[C, D](other: Traversal_[C, D, S, T]): IndexedTraversal_[I, C, D, A, B]

compose this IndexedLens_ with a Traversal_, having this IndexedLens_ applied last

compose this IndexedLens_ with a Traversal_, having this IndexedLens_ applied last

final def compose[C, D](other: ATraversal_[C, D, S, T]): IndexedTraversal_[I, C, D, A, B]

compose this IndexedLens_ with an ATraversal_, having this IndexedLens_ applied last

compose this IndexedLens_ with an ATraversal_, having this IndexedLens_ applied last

final def compose[C, D](other: Setter_[C, D, S, T]): IndexedSetter_[I, C, D, A, B]

compose an IndexedTraversal_ with a Setter_, having this IndexedLens_ applied last

compose an IndexedTraversal_ with a Setter_, having this IndexedLens_ applied last

final def compose[C, D](other: Getter_[C, D, S, T]): IndexedGetter_[I, C, D, A, B]

compose an IndexedTraversal_ with a Getter_, having this IndexedLens_ applied last

compose an IndexedTraversal_ with a Getter_, having this IndexedLens_ applied last

final def compose[C, D](other: Fold_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose an IndexedTraversal_ with a Fold_, having this IndexedLens_ applied last

compose an IndexedTraversal_ with a Fold_, having this IndexedLens_ applied last

final def cotraverse[F[_] : Comonad](fs: F[S])(f: F[(A, I)] => B): T

modify an effectual focus of an IndexedLens_ into the modified focus, resulting in a change of type to the full structure

modify an effectual focus of an IndexedLens_ into the modified focus, resulting in a change of type to the full structure

final def failover[F[_]](s: S)(f: (A, I) => B)(implicit ev0: Strong[[_, _] =>> Kleisli[[_] =>> (Disj[Boolean], _$7), _$8, _$9]], ev1: Alternative[F]): F[T]

try to map a function over this IndexedLens_, failing if the IndexedLens_ has no foci.

try to map a function over this IndexedLens_, failing if the IndexedLens_ has no foci.

final def over(f: (A, I) => B): S => T

modify the focus type of an IndexedLens_ using a function, resulting in a change of type to the full structure

modify the focus type of an IndexedLens_ using a function, resulting in a change of type to the full structure

final def reindex[J](f: I => J): IndexedLens_[J, S, T, A, B]

remap the index, resulting in a change of type to the full structure

remap the index, resulting in a change of type to the full structure

final override def traverse[F[_] : Applicative](s: S)(f: (A, I) => F[B]): F[T]

modify the focus type of an IndexedLens_ using a cats.Functor, resulting in a change of type to the full structure

modify the focus type of an IndexedLens_ using a cats.Functor, resulting in a change of type to the full structure

Definition Classes
final def unindex: Lens_[S, T, A, B]

synonym to asLens

synonym to asLens

final override def view(s: S): (A, I)

view the focus and the index of an IndexedLens_

view the focus and the index of an IndexedLens_

Definition Classes
final def zipWith[F[_]](s1: S, s2: S)(f: ((A, I), (A, I)) => B): T

zip two sources of an IndexedLens_ together provided a binary operation which modify the focus type of an IndexedLens_

zip two sources of an IndexedLens_ together provided a binary operation which modify the focus type of an IndexedLens_

final def zipWithF[F[_] : Comonad](f: F[(A, I)] => B)(fs: F[S]): T

synonym for cotraverse, flipped

synonym for cotraverse, flipped

Inherited methods

final def contains(a: (A, I))(s: S)(implicit ev: Eq[(A, I)]): Boolean

test whether a focus at specific index of an IndexedGetter contains a given value

test whether a focus at specific index of an IndexedGetter contains a given value

Inherited from:
IndexedGetter0
final override def exists(f: (A, I) => Boolean): S => Boolean

test whether a predicate holds for the focus of a Getter

test whether a predicate holds for the focus of a Getter

Definition Classes
Inherited from:
IndexedGetter1
def find(f: (A, I) => Boolean): S => Option[(A, I)]

find if a focus of an IndexedGetter that satisfies a predicate

find if a focus of an IndexedGetter that satisfies a predicate

Inherited from:
IndexedGetter0
protected def foldMap[R : Monoid](s: S)(f: (A, I) => R): R
Inherited from:
IndexedTraversal0
final def isEmpty(s: S): Boolean

check if the IndexedGetter does not contain a focus

check if the IndexedGetter does not contain a focus

Inherited from:
IndexedGetter0
final def nonEmpty(s: S): Boolean

check if the IndexedGetter contains a focus

check if the IndexedGetter contains a focus

Inherited from:
IndexedGetter0
final def notContains(a: (A, I))(s: S)(implicit ev: Eq[(A, I)]): Boolean

test whether a focus at specific index of an IndexedGetter does not contain a given value

test whether a focus at specific index of an IndexedGetter does not contain a given value

Inherited from:
IndexedGetter0
final def notExists(f: (A, I) => Boolean): S => Boolean

test whether a predicate does not hold for the focus of an IndexedGetter

test whether a predicate does not hold for the focus of an IndexedGetter

Inherited from:
IndexedGetter0
final def overF[F[_] : Applicative](f: (A, I) => F[B])(s: S): F[T]

synonym for traverse, flipped

synonym for traverse, flipped

Inherited from:
IndexedTraversal0
final def set(b: B): S => T

set the modified focus of an IndexedSetter

set the modified focus of an IndexedSetter

Inherited from:
IndexedSetter0
final def use(implicit ev: State[S, A]): State[S, (A, I)]

view the focus of a Getter in the state of a monad

view the focus of a Getter in the state of a monad

Inherited from:
IndexedGetter1
protected def viewOption(s: S): Option[(A, I)]
Inherited from:
IndexedGetter1