PIso

A PIso defines an isomorphism between types S, A and B, T:

             get                           reverse.get
    -------------------->             -------------------->
  S                       A         T                       B
    <--------------------             <--------------------
      reverse.reverseGet                   reverseGet

In addition, if f and g forms an isomorphism between A and B, i.e. if f . g = id and g . f = id, then a PIso defines an isomorphism between S and T:

    S           T                                   S           T
    |           ↑                                   ↑           |
    |           |                                   |           |
get |           | reverseGet     reverse.reverseGet |           | reverse.get
    |           |                                   |           |
    ↓     f     |                                   |     g     ↓
    A --------> B                                   A <-------- B

Iso is a type alias for PIso where S = A and T = B:

type Iso[S, A] = PIso[S, S, A, A]

A PIso is also a valid Getter, Fold, PLens, PPrism, POptional, PTraversal and PSetter

S: the source of a PIso
T: the modified source of a PIso
A: the target of a PIso
B: the modified target of a PIso

Self Type: PIso[S, T, A, B]
See also: monocle.law.IsoLaws

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Instance Constructors

new PIso()

Abstract Value Members

abstract def get(s: S): A

get the target of a PIso
abstract def reverse: PIso[B, A, T, S]

reverse a PIso: the source becomes the target and the target becomes the source
abstract def reverseGet(b: B): T

get the modified source of a PIso

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ^<->[C, D](other: PIso[A, B, C, D]): PIso[S, T, C, D]

alias to composeIso
alias to composeIso

Annotations
@inline()
final def ^<-?[C, D](other: PPrism[A, B, C, D]): PPrism[S, T, C, D]

alias to composePrism
alias to composePrism

Annotations
@inline()
final def ^|->[C, D](other: PLens[A, B, C, D]): PLens[S, T, C, D]

alias to composeLens
alias to composeLens

Annotations
@inline()
final def ^|->>[C, D](other: PTraversal[A, B, C, D]): PTraversal[S, T, C, D]

alias to composeTraversal
alias to composeTraversal

Annotations
@inline()
final def ^|-?[C, D](other: POptional[A, B, C, D]): POptional[S, T, C, D]

alias to composeOptional
alias to composeOptional

Annotations
@inline()
final def asFold: Fold[S, A]

view a PIso as a Fold
view a PIso as a Fold

Annotations
@inline()
final def asGetter: Getter[S, A]

view a PIso as a Getter
view a PIso as a Getter

Annotations
@inline()
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def asLens: PLens[S, T, A, B]

view a PIso as a PLens
view a PIso as a PLens

Annotations
@inline()
final def asOptional: POptional[S, T, A, B]

view a PIso as a POptional
view a PIso as a POptional

Annotations
@inline()
final def asPrism: PPrism[S, T, A, B]

view a PIso as a PPrism
view a PIso as a PPrism

Annotations
@inline()
final def asSetter: PSetter[S, T, A, B]

view a PIso as a Setter
view a PIso as a Setter

Annotations
@inline()
final def asTraversal: PTraversal[S, T, A, B]

view a PIso as a PTraversal
view a PIso as a PTraversal

Annotations
@inline()
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def composeFold[C](other: Fold[A, C]): Fold[S, C]

compose a PIso with a Fold
compose a PIso with a Fold

Annotations
@inline()
final def composeGetter[C](other: Getter[A, C]): Getter[S, C]

compose a PIso with a Getter
compose a PIso with a Getter

Annotations
@inline()
final def composeIso[C, D](other: PIso[A, B, C, D]): PIso[S, T, C, D]

compose a PIso with a PIso
compose a PIso with a PIso

Annotations
@inline()
final def composeLens[C, D](other: PLens[A, B, C, D]): PLens[S, T, C, D]

compose a PIso with a PLens
compose a PIso with a PLens

Annotations
@inline()
final def composeOptional[C, D](other: POptional[A, B, C, D]): POptional[S, T, C, D]

compose a PIso with a POptional
compose a PIso with a POptional

Annotations
@inline()
final def composePrism[C, D](other: PPrism[A, B, C, D]): PPrism[S, T, C, D]

compose a PIso with a PPrism
compose a PIso with a PPrism

Annotations
@inline()
final def composeSetter[C, D](other: PSetter[A, B, C, D]): PSetter[S, T, C, D]

compose a PIso with a PSetter
compose a PIso with a PSetter

Annotations
@inline()
final def composeTraversal[C, D](other: PTraversal[A, B, C, D]): PTraversal[S, T, C, D]

compose a PIso with a PTraversal
compose a PIso with a PTraversal

Annotations
@inline()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def first[C]: PIso[(S, C), (T, C), (A, C), (B, C)]

Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def left[C]: PIso[\/[S, C], \/[T, C], \/[A, C], \/[B, C]]

Annotations
@inline()
final def modify(f: (A) ⇒ B): (S) ⇒ T

modify polymorphically the target of a PIso with a function
modify polymorphically the target of a PIso with a function

Annotations
@inline()
final def modifyF[F[_]](f: (A) ⇒ F[B])(s: S)(implicit arg0: Functor[F]): F[T]

modify polymorphically the target of a PIso with a Functor function
modify polymorphically the target of a PIso with a Functor function

Annotations
@inline()
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def right[C]: PIso[\/[C, S], \/[C, T], \/[C, A], \/[C, B]]

Annotations
@inline()
final def second[C]: PIso[(C, S), (C, T), (C, A), (C, B)]

Annotations
@inline()
final def set(b: B): (S) ⇒ T

set polymorphically the target of a PIso with a value
set polymorphically the target of a PIso with a value

Annotations
@inline()
final def split[S1, T1, A1, B1](other: PIso[S1, T1, A1, B1]): PIso[(S, S1), (T, T1), (A, A1), (B, B1)]

pair two disjoint PIso
pair two disjoint PIso

Annotations
@inline()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

final def product[S1, T1, A1, B1](other: PIso[S1, T1, A1, B1]): PIso[(S, S1), (T, T1), (A, A1), (B, B1)]

Annotations
@deprecated @inline()
Deprecated
(Since version 1.2.0) use split

Related Docs: object PIso | package monocle

abstract class PIso[S, T, A, B] extends Serializable

Instance Constructors

new PIso()

Abstract Value Members

abstract def get(s: S): A

abstract def reverse: PIso[B, A, T, S]

abstract def reverseGet(b: B): T

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def ^<->[C, D](other: PIso[A, B, C, D]): PIso[S, T, C, D]

final def ^<-?[C, D](other: PPrism[A, B, C, D]): PPrism[S, T, C, D]

final def ^|->[C, D](other: PLens[A, B, C, D]): PLens[S, T, C, D]

final def ^|->>[C, D](other: PTraversal[A, B, C, D]): PTraversal[S, T, C, D]

final def ^|-?[C, D](other: POptional[A, B, C, D]): POptional[S, T, C, D]

final def asFold: Fold[S, A]

final def asGetter: Getter[S, A]

final def asInstanceOf[T0]: T0

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

final def asOptional: POptional[S, T, A, B]

final def asPrism: PPrism[S, T, A, B]

final def asSetter: PSetter[S, T, A, B]

final def asTraversal: PTraversal[S, T, A, B]

def clone(): AnyRef

final def composeFold[C](other: Fold[A, C]): Fold[S, C]

final def composeGetter[C](other: Getter[A, C]): Getter[S, C]

final def composeIso[C, D](other: PIso[A, B, C, D]): PIso[S, T, C, D]

final def composeLens[C, D](other: PLens[A, B, C, D]): PLens[S, T, C, D]

final def composeOptional[C, D](other: POptional[A, B, C, D]): POptional[S, T, C, D]

final def composePrism[C, D](other: PPrism[A, B, C, D]): PPrism[S, T, C, D]

final def composeSetter[C, D](other: PSetter[A, B, C, D]): PSetter[S, T, C, D]

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def first[C]: PIso[(S, C), (T, C), (A, C), (B, C)]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def left[C]: PIso[\/[S, C], \/[T, C], \/[A, C], \/[B, C]]

final def modify(f: (A) ⇒ B): (S) ⇒ T

final def modifyF[F[_]](f: (A) ⇒ F[B])(s: S)(implicit arg0: Functor[F]): F[T]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def right[C]: PIso[\/[C, S], \/[C, T], \/[C, A], \/[C, B]]

final def second[C]: PIso[(C, S), (C, T), (C, A), (C, B)]

final def set(b: B): (S) ⇒ T

final def split[S1, T1, A1, B1](other: PIso[S1, T1, A1, B1]): PIso[(S, S1), (T, T1), (A, A1), (B, B1)]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

final def product[S1, T1, A1, B1](other: PIso[S1, T1, A1, B1]): PIso[(S, S1), (T, T1), (A, A1), (B, B1)]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped