Proptics core/proptics/ALens_

ALens_

abstract class ALens_[S, T, A, B]

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

Type parameters:
A

the focus of a ALens_

B

the modified focus of a ALens_

S

the source of a ALens_

T

the modified source of a ALens_

Companion:
object
class Object
trait Matchable
class Any
ALens_[S, T, A, B]

Value members

Concrete methods

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

transform an ALens_ to a Lens_

transform an ALens_ to a Lens_

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

transform an ALens_ to a Lens_

transform an ALens_ to a Lens_

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

final def lensStore(s: S): (A, B => T)

convert an ALens_ into the form that a Lens_ accepts.

convert an ALens_ into the form that a Lens_ accepts.

Can be useful when final defining a lens where the focus appears under multiple constructors of an algebraic data type. This function would be called for each case of the data type.

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

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

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

final def toShop: Shop[A, B, S, T]

convert an ALens_ to a Shop[A, B, S, T]

convert an ALens_ to a Shop[A, B, S, T]

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

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

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

final def view(s: S): A

view the focus of a ALens_

view the focus of a ALens_

final def withLens[R](f: (S => A) => (S => B => T) => R): R

convert an ALens_ to the pair of functions that characterize it

convert an ALens_ to the pair of functions that characterize it

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 (hidden)
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

Inherited from:
Getter0 (hidden)
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 (hidden)
protected def foldMap[R : Monoid](s: S)(f: A => R): R
Inherited from:
Traversal0 (hidden)
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 (hidden)
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 (hidden)
final def overF[F[_] : Applicative](f: A => F[B])(s: S): F[T]

synonym for traverse, flipped

synonym for traverse, flipped

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

set the modified focus of a Setter

set the modified focus of a Setter

Inherited from:
Setter0 (hidden)
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 (hidden)