Proptics core/proptics/Lens_

Lens_

abstract class Lens_[S, T, A, B] extends Lens0[S, T, A, B]

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.

Type parameters:
A

the focus of a Lens_

B

the modified focus of a Lens_

S

the source of a Lens_

T

the modified source of a Lens_

Companion:
object
trait Lens0[S, T, A, B]
trait Getter1[S, A]
trait Getter0[S, A]
trait Traversal0[S, T, A, B]
trait Setter0[S, T, A, B]
class Object
trait Matchable
class Any
Lens_[S, T, A, B]

Value members

Concrete methods

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

compose this Lens_ with an AnIndexedLens_, having this Lens_ applied first

compose this Lens_ with an AnIndexedLens_, having this Lens_ applied first

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

compose this Lens_ with an IndexedTraversal_, having this Lens_ applied first

compose this Lens_ with an IndexedTraversal_, having this Lens_ applied first

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

compose this Lens_ with an IndexedSetter_, having this Lens_ applied first

compose this Lens_ with an IndexedSetter_, having this Lens_ applied first

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

compose this Lens_ with an IndexedGetter_, having this Lens_ applied first

compose this Lens_ with an IndexedGetter_, having this Lens_ applied first

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

compose this Lens_ with an IndexedFold_, having this Lens_ applied first

compose this Lens_ with an IndexedFold_, having this Lens_ applied first

final def asALens: ALens_[S, T, A, B]

transform a Lens_ to an ALens_

transform a Lens_ to an ALens_

final def asFold: Fold_[S, T, A, B]

transform a Lens_ to a Fold_

transform a Lens_ to a Fold_

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

compose this Lens_ with an AnIndexedLens_, having this Lens_ applied last

compose this Lens_ with an AnIndexedLens_, having this Lens_ applied last

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

compose this Lens_ with an IndexedTraversal_, having this Lens_ applied last

compose this Lens_ with an IndexedTraversal_, having this Lens_ applied last

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

compose this Lens_ with an IndexedFold_, having this Lens_ applied last

compose this Lens_ with an IndexedFold_, having this Lens_ applied last

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

compose this Lens_ with an IndexedGetter_, having this Lens_ applied last

compose this Lens_ with an IndexedGetter_, having this Lens_ applied last

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

compose this Lens_ with an IndexedFold_, having this Lens_ applied last

compose this Lens_ with an IndexedFold_, having this Lens_ applied last

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

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

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

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

try to map a function over this Lens_, failing if the Lens_ has no focus.

try to map a function over this Lens_, failing if the Lens_ has no focus.

final def focus[C, D](f: A => C): Getter_[S, T, C, D]

compose this Lens_ with a function lifted to a Getter_, having this Lens_ applied first

compose this Lens_ with a function lifted to a Getter_, having this Lens_ applied first

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

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

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

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

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

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

final override def view(s: S): A

view the focus of a Lens_

view the focus of a Lens_

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

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

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

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

synonym for cotraverse, flipped

synonym for cotraverse, flipped

Inherited methods

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

test whether the focus of a Getter contains a given value

test whether the focus of a Getter contains a given value

Inherited from:
Getter0
final override def exists(f: A => 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
Getter1 -> Getter0
Inherited from:
Getter1
final def find(f: A => Boolean): S => Option[A]

find the first focus of a Getter that satisfies a predicate, if there is any

find the first focus of a Getter that satisfies a predicate, if there is any

Inherited from:
Getter1
protected def foldMap[R : Monoid](s: S)(f: A => R): R
Inherited from:
Traversal0
final def isEmpty(s: S): Boolean

check if the Getter does not contain a focus

check if the Getter does not contain a focus

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

check if the Getter contains a focus

check if the Getter contains a focus

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

test whether the focus of a Getter does not contain a given value

test whether the focus of a Getter does not contain a given value

Inherited from:
Getter0
final def notExists(f: A => Boolean): S => Boolean

test whether a predicate does not hold for the focus of a Getter

test whether a predicate does not hold for the focus of a Getter

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

synonym for traverse, flipped

synonym for traverse, flipped

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

set the modified foci of a Setter

set the modified foci of a Setter

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

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:
Getter1
protected def viewOption(s: S): Option[A]
Inherited from:
Getter1