prism

Documentation

Overview

Prism is an optic used to select part of a sum type.

Index

• func AsTraversal[R ~func(func(A) HKTA) func(S) HKTS, S, A, HKTS, HKTA any](fof func(S) HKTS, fmap func(HKTA, func(A) S) HKTS) func(Prism[S, A]) R
• func Compose[S, A, B any](ab Prism[A, B]) func(Prism[S, A]) Prism[S, B]
• func IMap[S any, AB ~func(A) B, BA ~func(B) A, A, B any](ab AB, ba BA) func(Prism[S, A]) Prism[S, B]
• func Set[S, A any](a A) func(Prism[S, A]) EM.Endomorphism[S]
• type Prism
  • func FromPredicate[S any](pred func(S) bool) Prism[S, S]
  • func Id[S any]() Prism[S, S]
  • func MakePrism[S, A any](get func(S) O.Option[A], rev func(A) S) Prism[S, A]
  • func Some[S, A any](soa Prism[S, O.Option[A]]) Prism[S, A]

Functions

func AsTraversal

func AsTraversal[R ~func(func(A) HKTA) func(S) HKTS, S, A, HKTS, HKTA any](
	fof func(S) HKTS,
	fmap func(HKTA, func(A) S) HKTS,
) func(Prism[S, A]) R

AsTraversal converts a prism to a traversal

func Compose

func Compose[S, A, B any](ab Prism[A, B]) func(Prism[S, A]) Prism[S, B]

Compose composes a `Prism` with a `Prism`.

func IMap

func IMap[S any, AB ~func(A) B, BA ~func(B) A, A, B any](ab AB, ba BA) func(Prism[S, A]) Prism[S, B]

func Set

func Set[S, A any](a A) func(Prism[S, A]) EM.Endomorphism[S]

Types

type Prism

type Prism[S, A any] interface {
	GetOption(s S) O.Option[A]
	ReverseGet(a A) S
}

Prism is an optic used to select part of a sum type.

func FromPredicate

func FromPredicate[S any](pred func(S) bool) Prism[S, S]

func Id

func Id[S any]() Prism[S, S]

Id returns a prism implementing the identity operation

func MakePrism

func MakePrism[S, A any](get func(S) O.Option[A], rev func(A) S) Prism[S, A]

func Some

func Some[S, A any](soa Prism[S, O.Option[A]]) Prism[S, A]

Some returns a `Prism` from a `Prism` focused on the `Some` of a `Option` type.