core/monocle/POptional

POptional

trait POptional[S, T, A, B] extends PTraversal[S, T, A, B]

A POptional can be seen as a pair of functions:

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]
Type Params
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
trait PTraversal[S, T, A, B]
trait Fold[S, A]
trait PSetter[S, T, A, B]
trait Serializable
class Object
trait Matchable
class Any
trait PLens[S, T, A, B]
trait PIso[S, T, A, B]
trait PPrism[S, T, A, B]

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

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

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

get the modified source of a POptional

get the modified source of a POptional

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

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

Source
Optional.scala
def asTraversal: PTraversal[S, T, A, B]
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

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

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

check if there is no target

check if there is no target

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

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

check if there is a target

check if there is a target

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

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

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

Deprecated methods

@deprecated("use andThen", since = "3.0.0-M1")
def ^<->[C, D](other: PIso[A, B, C, D]): POptional[S, T, C, D]
Implicitly added by pOptionalSyntax

alias to composeIso

alias to composeIso

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

alias to composePrism

alias to composePrism

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

alias to composeLens

alias to composeLens

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

alias to composeTraversal

alias to composeTraversal

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

alias to composeOptional

alias to composeOptional

Deprecated
[Since version 3.0.0-M1]
Source
Optional.scala
@deprecated("use andThen", since = "3.0.0-M1")
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

Deprecated
[Since version 3.0.0-M1]
Source
Optional.scala
@deprecated("use andThen", since = "3.0.0-M1")
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

Deprecated
[Since version 3.0.0-M1]
Source
Optional.scala
@deprecated("use andThen", since = "3.0.0-M1")
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

Deprecated
[Since version 3.0.0-M1]
Source
Optional.scala
@deprecated("use andThen", since = "3.0.0-M1")
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

Deprecated
[Since version 3.0.0-M1]
Source
Optional.scala
@deprecated("use andThen", since = "3.0.0-M1")
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

Deprecated
[Since version 3.0.0-M1]
Source
Optional.scala
@deprecated("use andThen", since = "3.0.0-M1")
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

Deprecated
[Since version 3.0.0-M1]
Source
Optional.scala
@deprecated("use andThen", since = "3.0.0-M1")
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

Deprecated
[Since version 3.0.0-M1]
Source
Optional.scala
@deprecated("use andThen", since = "3.0.0-M1")
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

Deprecated
[Since version 3.0.0-M1]
Source
Optional.scala
@deprecated("no replacement", since = "3.0.0-M4")
def first[C]: POptional[(S, C), (T, C), (A, C), (B, C)]
Deprecated
[Since version 3.0.0-M4]
Source
Optional.scala
@deprecated("no replacement", since = "3.0.0-M4")
def second[C]: POptional[(C, S), (C, T), (C, A), (C, B)]
Deprecated
[Since version 3.0.0-M4]
Source
Optional.scala
@deprecated("use replaceOption instead", since = "3.0.0-M1")
def setOption(b: B): S => Option[T]

alias to replaceOption

alias to replaceOption

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

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

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

Inherited from
PSetter
Source
Setter.scala
def asFold: Fold[S, A]

view a PTraversal as a Fold

view a PTraversal as a Fold

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

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

combine all targets using a target's Monoid

combine all targets using a target's Monoid

Inherited from
Fold
Source
Fold.scala
def foldMap[M](f: A => M)(s: S)(`evidence$2`: Monoid[M]): M

map each target to a Monoid and combine the results

map each target to a Monoid and combine the results

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

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

get the first target

get the first target

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

get the last target

get the last target

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

calculate the number of targets

calculate the number of targets

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

Inherited from
PTraversal
Source
Traversal.scala
def modifyA[F[_]](f: A => F[B])(s: S)(`evidence$1`: Applicative[F]): 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

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

PTraversal.modifyA for a Parallel applicative functor.

PTraversal.modifyA for a Parallel applicative functor.

Inherited from
PTraversal
Source
Traversal.scala
def productElementNames: Iterator[String]
Implicitly added by pOptionalSyntax
Inherited from
Product
def productIterator: Iterator[Any]
Implicitly added by pOptionalSyntax
Inherited from
Product
def some[A1](ev1: A =:= Option[A1]): Fold[S, A1]
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

Inherited from
Fold
Source
Fold.scala

Deprecated and Inherited methods

@deprecated("no replacement", since = "3.0.0-M4")
def left[C]: Fold[Either[S, C], Either[A, C]]
Deprecated
[Since version 3.0.0-M4]
Inherited from
Fold
Source
Fold.scala
@deprecated("no replacement", since = "3.0.0-M4")
def right[C]: Fold[Either[C, S], Either[C, A]]
Deprecated
[Since version 3.0.0-M4]
Inherited from
Fold
Source
Fold.scala
@deprecated("use replace instead", since = "3.0.0-M1")
def set(b: B): S => T

alias to replace

alias to replace

Deprecated
[Since version 3.0.0-M1]
Inherited from
PSetter
Source
Setter.scala