com.mojang.datafixers.optics.profunctors

Interface Cocartesian<P extends K2,Mu extends Cocartesian _>

Type Parameters:

P - The transformation type.

Mu - The witness type for this profunctor.

All Superinterfaces:

Mu<P>, Kind2 P, Profunctor P

All Known Subinterfaces:

AffineP<P,Mu>, Mapping<P,Mu>, TraversalP<P,Mu>

All Known Implementing Classes:

Affine.Instance, ForgetOpt.Instance, FunctionType.Instance, Prism.Instance, ReForgetC.Instance, Traversal.Instance

public interface Cocartesian<P extends K2,Mu extends Cocartesian _>
extends Profunctor P

A profunctor that supports converting a transformation acting on some type to and from a transformation acting on eithers holding that type. This allows one to add a "pass-through" value to the type transformed via the profunctor that is left untransformed.

Type Shape:

%.Type. %0

Method Summary

Modifier and Type	Method and Description
<A,B,C> P<(A|C),(B|C)>	left(P<A,B> input) Converts the given transformation into one that transforms the left type of an Either.
default <A,B,C> P<(C|A),(C|B)>	right(P<A,B> input) Converts the given transformation into one that transforms the right type of an Either.
default FunctorProfunctor<CocartesianLike _> P	toFP() Converts this profunctor into a FunctorProfunctor that distributes CocartesianLike functors.

Methods inherited from interface com.mojang.datafixers.optics.profunctors.Profunctor

dimap, dimap, dimap, lmap, rmap

Method Detail

left

<A,B,C> P<(A|C),(B|C)> left(P<A,B> input)

Converts the given transformation into one that transforms the left type of an Either. The right type of the Either is left unchanged by the returned transformation.

Type Parameters:

A - The input type.

B - The output type.

C - A "pass-through" type that is not transformed.

Parameters:

input - The transformation.

Returns:

A transformation on the left type of an Either.

right

default <A,B,C> P<(C|A),(C|B)> right(P<A,B> input)

Converts the given transformation into one that transforms the right type of an Either. The left type of the Either is left unchanged by the returned transformation.

Implementation Requirements:

The default implementation calls left(App2) and swaps the order of the types in the Either.

Type Parameters:

A - The input type.

B - The output type.

C - A "pass-through" type that is not transformed.

Parameters:

input - The transformation.

Returns:

A transformation on the right type of an Either.

toFP

default FunctorProfunctor<CocartesianLike _> P toFP()

Converts this profunctor into a FunctorProfunctor that distributes CocartesianLike functors.