com.mojang.datafixers.optics.profunctors

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

Type Parameters:

P - The type of transformation.

Mu - The witness type for this profunctor.

All Superinterfaces:

AffineP P, Mu<P>, Cartesian P, Cocartesian P, Kind2 P, Profunctor P

All Known Subinterfaces:

Mapping<P,Mu>

All Known Implementing Classes:

FunctionType.Instance, Traversal.Instance

public interface TraversalP<P extends K2,Mu extends TraversalP _>
extends AffineP P

The Profunctor type class for Traversal optics. This type extends AffineP with the method wander(Wander, App2), which applies a given Wander transformation to the input.

Type Shape:

%.Type. %0

Method Summary

Modifier and Type	Method and Description
default <A,B,C> P<(A,C),(B,C)>	first(P<A,B> input) Converts the given transformation into one that transforms the first type of a Pair.
default <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 FunctorProfunctor<Traversable _> P	toFP3() Converts this profunctor into a FunctorProfunctor that distributes Traversable functors.
default <T extends K1,A,B> P<T<A>,T<B>>	traverse(Traversable T traversable, P<A,B> input) Takes a Traversable instance and some input transformation, and produces an output transformation between the effects defined by the traversable instance.
<S,T,A,B> P<S,T>	wander(Wander<S::A,T::B> wander, P<A,B> input) Takes an operation defined by Wander and a transformation between field types, and produces a transformation between object types.

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

second, toFP2

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

right, toFP

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

dimap, dimap, dimap, lmap, rmap

Method Detail

wander

<S,T,A,B> P<S,T> wander(Wander<S::A,T::B> wander,
                        P<A,B> input)

Takes an operation defined by Wander and a transformation between field types, and produces a transformation between object types.

The returned transformation should accept an object S, extract a field A, apply the given input, and return the resulting B via an output object T, all in the context of some effectful computation defined by the wander.

Type Parameters:

S - The input object type.

T - The output object type.

A - The input field type.

B - The output field type.

Parameters:

wander - A mapping from effectful functions on the field types to effectful functions on the object types.

input - A (non-effectful) transformation between object types.

Returns:

A transformation between object types.

See Also:

Wander, Traversable

traverse

default <T extends K1,A,B> P<T<A>,T<B>> traverse(Traversable T traversable,
                                                 P<A,B> input)

Takes a Traversable instance and some input transformation, and produces an output transformation between the effects defined by the traversable instance.

This is a specialization of wander(Wander, App2) where S' = T<A> and T' = T<B>.

Implementation Requirements:

The default implementation calls wander(Wander, App2) with a Wander value that uses the given Traversable to traverse inputs.

Type Parameters:

T - The traversable type.

A - The input field type.

B - The output field type.

Parameters:

traversable - A Traversable instance for T.

input - A transformation between field types.

Returns:

A transformation between effects of the field types.

first

default <A,B,C> P<(A,C),(B,C)> first(P<A,B> input)

Description copied from interface: Cartesian

Converts the given transformation into one that transforms the first type of a Pair. The second type is not transformed - any values of that type are passed through the returned transformation unchanged.

Specified by:

first in interface Cartesian P extends K2

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 pairs, where the first type is transformed and the second is not.

left

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

Description copied from interface: Cocartesian

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.

Specified by:

left in interface Cocartesian P extends K2

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.

toFP3

default FunctorProfunctor<Traversable _> P toFP3()

Converts this profunctor into a FunctorProfunctor that distributes Traversable functors.