core
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
core/monocle/PTraversal

PTraversal

monocle.PTraversal
See thePTraversal companion object
trait PTraversal[S, T, A, B] extends PSetter[S, T, A, B] with Fold[S, A]

A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite.

PTraversal stands for Polymorphic Traversal as it replace and modify methods change a type A to B and S to T. Traversal is a type alias for PTraversal restricted to monomorphic updates:

type Traversal[S, A] = PTraversal[S, S, A, A]

Attributes

A

the target of a PTraversal

B

the modified target of a PTraversal

S

the source of a PTraversal

T

the modified source of a PTraversal

See also:
Companion:
object
Source:
Traversal.scala
Graph
Supertypes
trait Fold[S, A]
trait PSetter[S, T, A, B]
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
trait POptional[S, T, A, B]
trait PLens[S, T, A, B]
trait PIso[S, T, A, B]
trait PPrism[S, T, A, B]
Self type
PTraversal[S, T, A, B]

Members list

Concise view

Value members

Abstract methods

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

modify polymorphically the target of a PTraversal with an Applicative function all traversal methods are written in terms of modifyA

modify polymorphically the target of a PTraversal with an Applicative function all traversal methods are written in terms of modifyA

Attributes

Source:
Traversal.scala

Concrete methods

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

compose a PTraversal with another PTraversal

compose a PTraversal with another PTraversal

Attributes

Source:
Traversal.scala
def asFold: Fold[S, A]

view a PTraversal as a Fold

view a PTraversal as a Fold

Attributes

Source:
Traversal.scala
def asSetter: PSetter[S, T, A, B]

view a PTraversal as a PSetter

view a PTraversal as a PSetter

Attributes

Source:
Traversal.scala
def foldMap[M : Monoid](f: A => M)(s: S): M

map each target to a Monoid and combine the results

map each target to a Monoid and combine the results

Attributes

Source:
Traversal.scala
override def index[I, A1](i: I)(implicit evIndex: Index[A, I, A1], evMonoS: S =:= T, evMonoA: A =:= B): Traversal[S, A1]

Attributes

Definition Classes
Source:
Traversal.scala
def modify(f: A => B): S => T

modify polymorphically the target of a PTraversal with a function

modify polymorphically the target of a PTraversal with a function

Attributes

Source:
Traversal.scala
def parModifyF[F[_]](f: A => F[B])(s: S)(implicit F: Parallel[F]): F[T]

PTraversal.modifyA for a Parallel applicative functor.

PTraversal.modifyA for a Parallel applicative functor.

Attributes

Source:
Traversal.scala
def replace(b: B): S => T

replace polymorphically the target of a PTraversal with a value

replace polymorphically the target of a PTraversal with a value

Attributes

Source:
Traversal.scala
override def some[A1, B1](implicit ev1: A =:= Option[A1], ev2: B =:= Option[B1]): PTraversal[S, T, A1, B1]

Attributes

Definition Classes
Source:
Traversal.scala

Deprecated methods

def ^<->[C, D](other: PIso[A, B, C, D]): PTraversal[S, T, C, D]
Implicitly added by pTraversalSyntax

alias to composeIso

alias to composeIso

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def ^<-?[C, D](other: PPrism[A, B, C, D]): PTraversal[S, T, C, D]
Implicitly added by pTraversalSyntax

alias to composePrism

alias to composePrism

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def ^|->[C, D](other: PLens[A, B, C, D]): PTraversal[S, T, C, D]
Implicitly added by pTraversalSyntax

alias to composeLens

alias to composeLens

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def ^|->>[C, D](other: PTraversal[A, B, C, D]): PTraversal[S, T, C, D]
Implicitly added by pTraversalSyntax

alias to composeTraversal

alias to composeTraversal

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def ^|-?[C, D](other: POptional[A, B, C, D]): PTraversal[S, T, C, D]
Implicitly added by pTraversalSyntax

alias to composeOptional

alias to composeOptional

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def composeFold[C](other: Fold[A, C]): Fold[S, C]
Implicitly added by pTraversalSyntax

compose a PTraversal with a Fold

compose a PTraversal with a Fold

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def composeGetter[C](other: Getter[A, C]): Fold[S, C]
Implicitly added by pTraversalSyntax

compose a PTraversal with a Getter

compose a PTraversal with a Getter

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def composeIso[C, D](other: PIso[A, B, C, D]): PTraversal[S, T, C, D]
Implicitly added by pTraversalSyntax

compose a PTraversal with a PIso

compose a PTraversal with a PIso

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def composeLens[C, D](other: PLens[A, B, C, D]): PTraversal[S, T, C, D]
Implicitly added by pTraversalSyntax

compose a PTraversal with a PLens

compose a PTraversal with a PLens

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def composeOptional[C, D](other: POptional[A, B, C, D]): PTraversal[S, T, C, D]
Implicitly added by pTraversalSyntax

compose a PTraversal with a POptional

compose a PTraversal with a POptional

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def composePrism[C, D](other: PPrism[A, B, C, D]): PTraversal[S, T, C, D]
Implicitly added by pTraversalSyntax

compose a PTraversal with a PPrism

compose a PTraversal with a PPrism

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def composeSetter[C, D](other: PSetter[A, B, C, D]): PSetter[S, T, C, D]
Implicitly added by pTraversalSyntax

compose a PTraversal with a PSetter

compose a PTraversal with a PSetter

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala
def composeTraversal[C, D](other: PTraversal[A, B, C, D]): PTraversal[S, T, C, D]
Implicitly added by pTraversalSyntax

compose a PTraversal with a PTraversal

compose a PTraversal with a PTraversal

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Traversal.scala

Inherited methods

def all(p: A => Boolean): S => Boolean

check if all targets satisfy the predicate

check if all targets satisfy the predicate

Attributes

Inherited from:
Fold
Source:
Fold.scala
def andThen[B](other: Fold[A, B]): Fold[S, B]

compose a Fold with another Fold

compose a Fold with another Fold

Attributes

Inherited from:
Fold
Source:
Fold.scala
def andThen[C, D](other: PSetter[A, B, C, D]): PSetter[S, T, C, D]

compose a PSetter with another PSetter

compose a PSetter with another PSetter

Attributes

Inherited from:
PSetter
Source:
Setter.scala
def exist(p: A => Boolean): S => Boolean

check if at least one target satisfies the predicate

check if at least one target satisfies the predicate

Attributes

Inherited from:
Fold
Source:
Fold.scala
def find(p: A => Boolean): S => Option[A]

find the first target matching the predicate

find the first target matching the predicate

Attributes

Inherited from:
Fold
Source:
Fold.scala
def fold(s: S)(implicit ev: Monoid[A]): A

combine all targets using a target's Monoid

combine all targets using a target's Monoid

Attributes

Inherited from:
Fold
Source:
Fold.scala
def getAll(s: S): List[A]

get all the targets of a Fold

get all the targets of a Fold

Attributes

Inherited from:
Fold
Source:
Fold.scala
def headOption(s: S): Option[A]

get the first target

get the first target

Attributes

Inherited from:
Fold
Source:
Fold.scala
def index[I, A1](i: I)(implicit evIndex: Index[A, I, A1]): Fold[S, A1]

Attributes

Inherited from:
Fold
Source:
Fold.scala
def isEmpty(s: S): Boolean

check if there is no target

check if there is no target

Attributes

Inherited from:
Fold
Source:
Fold.scala
def lastOption(s: S): Option[A]

get the last target

get the last target

Attributes

Inherited from:
Fold
Source:
Fold.scala
def length(s: S): Int

calculate the number of targets

calculate the number of targets

Attributes

Inherited from:
Fold
Source:
Fold.scala
def nonEmpty(s: S): Boolean

check if there is at least one target

check if there is at least one target

Attributes

Inherited from:
Fold
Source:
Fold.scala
def productElementNames: Iterator[String]
Implicitly added by pTraversalSyntax

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]
Implicitly added by pTraversalSyntax

Attributes

Inherited from:
Product
def some[A1](implicit ev1: A =:= Option[A1]): Fold[S, A1]

Attributes

Inherited from:
Fold
Source:
Fold.scala
def to[C](f: A => C): Fold[S, C]

Compose with a function lifted into a Getter

Compose with a function lifted into a Getter

Attributes

Inherited from:
Fold
Source:
Fold.scala

Deprecated and Inherited methods

def left[C]: Fold[Either[S, C], Either[A, C]]

Attributes

Deprecated
[Since version 3.0.0-M4]
Inherited from:
Fold
Source:
Fold.scala
def right[C]: Fold[Either[C, S], Either[C, A]]

Attributes

Deprecated
[Since version 3.0.0-M4]
Inherited from:
Fold
Source:
Fold.scala
def set(b: B): S => T

alias to replace

alias to replace

Attributes

Deprecated
[Since version 3.0.0-M1]
Inherited from:
PSetter
Source:
Setter.scala
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL