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

POptional

monocle.POptional
See thePOptional companion object
trait POptional[S, T, A, B] extends PTraversal[S, T, A, B]

A POptional can be seen as a pair of functions:

  • getOrModify: S => Either[T, A]
  • replace : (B, S) => T

A POptional could also be defined as a weaker PLens and weaker PPrism

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

type Optional[S, A] = POptional[S, S, A, A]

Attributes

A

the target of a POptional

B

the modified target of a POptional

S

the source of a POptional

T

the modified source of a POptional

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

Members list

Concise view

Value members

Abstract methods

def getOption(s: S): Option[A]

get the target of a POptional or nothing if there is no target

get the target of a POptional or nothing if there is no target

Attributes

Source:
Optional.scala
def getOrModify(s: S): Either[T, A]

get the target of a POptional or return the original value while allowing the type to change if it does not match

get the target of a POptional or return the original value while allowing the type to change if it does not match

Attributes

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

get the modified source of a POptional

get the modified source of a POptional

Attributes

Source:
Optional.scala

Concrete methods

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

check if there is no target or the target satisfies the predicate

check if there is no target or the target satisfies the predicate

Attributes

Definition Classes
Source:
Optional.scala
def andThen[C, D](other: POptional[A, B, C, D]): POptional[S, T, C, D]

compose a POptional with a POptional

compose a POptional with a POptional

Attributes

Source:
Optional.scala
def asTraversal: PTraversal[S, T, A, B]

view a POptional as a PTraversal

view a POptional as a PTraversal

Attributes

Source:
Optional.scala
override def exist(p: A => Boolean): S => Boolean

check if there is a target and it satisfies the predicate

check if there is a target and it satisfies the predicate

Attributes

Definition Classes
Source:
Optional.scala
override def find(p: A => Boolean): S => Option[A]

find if the target satisfies the predicate

find if the target satisfies the predicate

Attributes

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

Attributes

Definition Classes
Source:
Optional.scala
override def isEmpty(s: S): Boolean

check if there is no target

check if there is no target

Attributes

Definition Classes
Source:
Optional.scala
def modifyOption(f: A => B): S => Option[T]

modify polymorphically the target of a POptional with a function. return empty if the POptional is not matching

modify polymorphically the target of a POptional with a function. return empty if the POptional is not matching

Attributes

Source:
Optional.scala
override def nonEmpty(s: S): Boolean

check if there is a target

check if there is a target

Attributes

Definition Classes
Source:
Optional.scala
def orElse(other: POptional[S, T, A, B]): POptional[S, T, A, B]

fall-back to another POptional in case this one doesn't match

fall-back to another POptional in case this one doesn't match

Attributes

Source:
Optional.scala
def replaceOption(b: B): S => Option[T]

replace polymorphically the target of a POptional with a value. return empty if the POptional is not matching

replace polymorphically the target of a POptional with a value. return empty if the POptional is not matching

Attributes

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

Attributes

Definition Classes
Source:
Optional.scala

Deprecated methods

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

alias to composeIso

alias to composeIso

Attributes

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

alias to composePrism

alias to composePrism

Attributes

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

alias to composeLens

alias to composeLens

Attributes

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

alias to composeTraversal

alias to composeTraversal

Attributes

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

alias to composeOptional

alias to composeOptional

Attributes

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

compose a POptional with a Fold

compose a POptional with a Fold

Attributes

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

compose a POptional with a Getter

compose a POptional with a Getter

Attributes

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

compose a POptional with a PIso

compose a POptional with a PIso

Attributes

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

compose a POptional with a PLens

compose a POptional with a PLens

Attributes

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

compose a POptional with a POptional

compose a POptional with a POptional

Attributes

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

compose a POptional with a PPrism

compose a POptional with a PPrism

Attributes

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

compose a POptional with a PSetter

compose a POptional with a PSetter

Attributes

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

compose a POptional with a PTraversal

compose a POptional with a PTraversal

Attributes

Deprecated
[Since version 3.0.0-M1]
Source:
Optional.scala
def first[C]: POptional[(S, C), (T, C), (A, C), (B, C)]

Attributes

Deprecated
[Since version 3.0.0-M4]
Source:
Optional.scala
def second[C]: POptional[(C, S), (C, T), (C, A), (C, B)]

Attributes

Deprecated
[Since version 3.0.0-M4]
Source:
Optional.scala
def setOption(b: B): S => Option[T]

alias to replaceOption

alias to replaceOption

Attributes

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

Inherited 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

Inherited from:
PTraversal
Source:
Traversal.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 asFold: Fold[S, A]

view a PTraversal as a Fold

view a PTraversal as a Fold

Attributes

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

view a PTraversal as a PSetter

view a PTraversal as a PSetter

Attributes

Inherited from:
PTraversal
Source:
Traversal.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 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

Inherited from:
PTraversal
Source:
Traversal.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 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 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

Inherited from:
PTraversal
Source:
Traversal.scala
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

Inherited from:
PTraversal
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

Inherited from:
PTraversal
Source:
Traversal.scala
def productElementNames: Iterator[String]
Implicitly added by pOptionalSyntax

Attributes

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

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