Uses of Interface
com.github.tonivade.purefun.type.Option

Packages that use Option

Package	Description
com.github.tonivade.purefun.concurrent
com.github.tonivade.purefun.core
com.github.tonivade.purefun.data
com.github.tonivade.purefun.effect
com.github.tonivade.purefun.instances
com.github.tonivade.purefun.monad
com.github.tonivade.purefun.optics
com.github.tonivade.purefun.stream
com.github.tonivade.purefun.transformer
com.github.tonivade.purefun.type
com.github.tonivade.purefun.typeclasses

Uses of Option in com.github.tonivade.purefun.concurrent

Methods in com.github.tonivade.purefun.concurrent that return Option

Modifier and Type	Method	Description
private Option<Try<T>>	PromiseImpl.current(Consumer1<? super Try<? extends T>> consumer)

Uses of Option in com.github.tonivade.purefun.core

Methods in com.github.tonivade.purefun.core that return types with arguments of type Option

Modifier and Type	Method	Description
default Function1<A,Option<R>>	PartialFunction1.lift()
default Function2<A,B,Option<R>>	PartialFunction2.lift()
default Function3<A,B,C,Option<R>>	PartialFunction3.lift()
default Function1<A,Option<R>>	Function1.liftOption()
default Function2<A,B,Option<R>>	Function2.liftOption()
default Producer<Option<T>>	Producer.liftOption()

Uses of Option in com.github.tonivade.purefun.data

Methods in com.github.tonivade.purefun.data that return Option

Modifier and Type	Method	Description
Option<E>	ImmutableTree.ceiling(E value)
Option<E>	ImmutableTree.PImmutableTree.ceiling(E value)
Option<Tuple2<K,V>>	ImmutableTreeMap.ceilingEntry(K key)
Option<Tuple2<K,V>>	ImmutableTreeMap.PImmutableTreeMap.ceilingEntry(K key)
default Option<K>	ImmutableTreeMap.ceilingKey(K key)
default Option<E>	Sequence.findFirst(Matcher1<? super E> matcher)
Option<E>	ImmutableTree.floor(E value)
Option<E>	ImmutableTree.PImmutableTree.floor(E value)
Option<Tuple2<K,V>>	ImmutableTreeMap.floorEntry(K key)
Option<Tuple2<K,V>>	ImmutableTreeMap.PImmutableTreeMap.floorEntry(K key)
default Option<K>	ImmutableTreeMap.floorKey(K key)
Option<V>	ImmutableMap.get(K key)
Option<V>	ImmutableMap.PImmutableMap.get(K key)
Option<V>	ImmutableTreeMap.PImmutableTreeMap.get(K key)
Option<E>	ImmutableList.head()
Option<E>	ImmutableList.PImmutableList.head()
Option<E>	ImmutableTree.head()
Option<E>	ImmutableTree.PImmutableTree.head()
Option<E>	NonEmptyList.head()
Option<Tuple2<K,V>>	ImmutableTreeMap.headEntry()
Option<Tuple2<K,V>>	ImmutableTreeMap.PImmutableTreeMap.headEntry()
default Option<K>	ImmutableTreeMap.headKey()
Option<E>	ImmutableTree.higher(E value)
Option<E>	ImmutableTree.PImmutableTree.higher(E value)
Option<Tuple2<K,V>>	ImmutableTreeMap.higherEntry(K key)
Option<Tuple2<K,V>>	ImmutableTreeMap.PImmutableTreeMap.higherEntry(K key)
default Option<K>	ImmutableTreeMap.higherKey(K key)
Option<E>	ImmutableTree.lower(E value)
Option<E>	ImmutableTree.PImmutableTree.lower(E value)
Option<Tuple2<K,V>>	ImmutableTreeMap.lowerEntry(K key)
Option<Tuple2<K,V>>	ImmutableTreeMap.PImmutableTreeMap.lowerEntry(K key)
default Option<K>	ImmutableTreeMap.lowerKey(K key)
default Option<E>	Sequence.reduce(Operator2<E> operator)
Option<E>	ImmutableTree.PImmutableTree.tail()
Option<E>	ImmutableTree.tail()
Option<Tuple2<K,V>>	ImmutableTreeMap.PImmutableTreeMap.tailEntry()
Option<Tuple2<K,V>>	ImmutableTreeMap.tailEntry()
default Option<K>	ImmutableTreeMap.tailKey()

Uses of Option in com.github.tonivade.purefun.effect

Methods in com.github.tonivade.purefun.effect that return Option

Modifier and Type	Method	Description
Option<PureIO<R,E,A>>	CallStack.tryHandle(Throwable error)
Option<PureIO<R,E,A>>	StackItem.tryHandle(Throwable error)

Methods in com.github.tonivade.purefun.effect with parameters of type Option

Modifier and Type	Method	Description
static <A> EIO<Throwable,A>	EIO.fromOption(Option<? extends A> task)
static <R, A> PureIO<R,Throwable,A>	PureIO.fromOption(Option<? extends A> task)
static <R, A> RIO<R,A>	RIO.fromOption(Option<? extends A> task)
static <A> Task<A>	Task.fromOption(Option<? extends A> task)
static <T> UIO<T>	UIO.fromOption(Option<? extends T> task)
static <R, T> URIO<R,T>	URIO.fromOption(Option<? extends T> task)

Method parameters in com.github.tonivade.purefun.effect with type arguments of type Option

Modifier and Type	Method	Description
static <A> EIO<Throwable,A>	EIO.fromOption(Producer<Option<? extends A>> task)
static <R, A> PureIO<R,Throwable,A>	PureIO.fromOption(Producer<Option<? extends A>> task)
static <R, A> RIO<R,A>	RIO.fromOption(Producer<Option<? extends A>> task)
static <A> Task<A>	Task.fromOption(Producer<Option<? extends A>> task)
static <A, B> Function1<A,EIO<Throwable,B>>	EIO.liftOption(Function1<? super A,? extends Option<? extends B>> function)
static <R, A, B> Function1<A,PureIO<R,Throwable,B>>	PureIO.liftOption(Function1<? super A,? extends Option<? extends B>> function)
static <R, A, B> Function1<A,RIO<R,B>>	RIO.liftOption(Function1<? super A,? extends Option<? extends B>> function)
static <A, B> Function1<A,Task<B>>	Task.liftOption(Function1<? super A,? extends Option<? extends B>> function)
static <A, B> Function1<A,UIO<B>>	UIO.liftOption(Function1<? super A,? extends Option<? extends B>> function)
static <R, A, B> Function1<A,URIO<R,B>>	URIO.liftOption(Function1<? super A,? extends Option<? extends B>> function)

Uses of Option in com.github.tonivade.purefun.instances

Methods in com.github.tonivade.purefun.instances that return types with arguments of type Option

Modifier and Type	Method	Description
static Alternative<Option<?>>	OptionInstances.alternative()
default <T, R> Kind<Option<?>,R>	OptionApplicative.ap(Kind<Option<?>,? extends T> value, Kind<Option<?>,? extends Function1<? super T,? extends R>> apply)
static Applicative<Option<?>>	OptionInstances.applicative()
default <T> Kind<Option<?>,T>	OptionSemigroupK.combineK(Kind<Option<?>,? extends T> t1, Kind<Option<?>,? extends T> t2)
static <T> Eq<Kind<Option<?>,T>>	OptionInstances.eq(Eq<T> eqSome)
default <T, R> Kind<Option<?>,R>	OptionMonad.flatMap(Kind<Option<?>,? extends T> value, Function1<? super T,? extends Kind<Option<?>,? extends R>> map)
static Foldable<Option<?>>	OptionInstances.foldable()
static Functor<Option<?>>	OptionInstances.functor()
default <A> Kind<Option<?>,A>	OptionMonadError.handleErrorWith(Kind<Option<?>,A> value, Function1<? super Unit,? extends Kind<Option<?>,? extends A>> handler)
private <T, R> Trampoline<Kind<Option<?>,R>>	OptionMonad.loop(T value, Function1<T,? extends Kind<Option<?>,Either<T,R>>> map)
default <T, R> Kind<Option<?>,R>	OptionFunctor.map(Kind<Option<?>,? extends T> value, Function1<? super T,? extends R> mapper)
static Monad<Option<?>>	OptionInstances.monad()
static MonadError<Option<?>,Unit>	OptionInstances.monadError()
default <A, B> Kind<Option<?>,Tuple2<A,B>>	OptionSemigroupal.product(Kind<Option<?>,? extends A> fa, Kind<Option<?>,? extends B> fb)
default <T> Kind<Option<?>,T>	OptionPure.pure(T value)
default <A> Kind<Option<?>,A>	OptionMonadError.raiseError(Unit error)
static Semigroupal<Option<?>>	OptionInstances.semigroupal()
default <T, R> Kind<Option<?>,R>	OptionMonad.tailRecM(T value, Function1<T,? extends Kind<Option<?>,Either<T,R>>> map)
static Traverse<Option<?>>	OptionInstances.traverse()
default <G extends Kind<G, ?>, T, R> Kind<G,Kind<Option<?>,R>>	OptionTraverse.traverse(Applicative<G> applicative, Kind<Option<?>,T> value, Function1<? super T,? extends Kind<G,? extends R>> mapper)
default <T> Kind<Option<?>,T>	OptionMonoidK.zero()

Method parameters in com.github.tonivade.purefun.instances with type arguments of type Option

Modifier and Type	Method	Description
default <T, R> Kind<Option<?>,R>	OptionApplicative.ap(Kind<Option<?>,? extends T> value, Kind<Option<?>,? extends Function1<? super T,? extends R>> apply)
default <T> Kind<Option<?>,T>	OptionSemigroupK.combineK(Kind<Option<?>,? extends T> t1, Kind<Option<?>,? extends T> t2)
static <F extends Kind<F, ?>, T> Eq<Kind<OptionT<F,?>,T>>	OptionTInstances.eq(Eq<Kind<F,Option<T>>> eq)
default <T, R> Kind<Option<?>,R>	OptionMonad.flatMap(Kind<Option<?>,? extends T> value, Function1<? super T,? extends Kind<Option<?>,? extends R>> map)
default <T, R> Kind<Option<?>,R>	OptionMonad.flatMap(Kind<Option<?>,? extends T> value, Function1<? super T,? extends Kind<Option<?>,? extends R>> map)
default <A, B> B	OptionFoldable.foldLeft(Kind<Option<?>,? extends A> value, B initial, Function2<? super B,? super A,? extends B> mapper)
default <A, B> Eval<B>	OptionFoldable.foldRight(Kind<Option<?>,? extends A> value, Eval<? extends B> initial, Function2<? super A,? super Eval<? extends B>,? extends Eval<? extends B>> mapper)
default <A> Kind<Option<?>,A>	OptionMonadError.handleErrorWith(Kind<Option<?>,A> value, Function1<? super Unit,? extends Kind<Option<?>,? extends A>> handler)
default <A> Kind<Option<?>,A>	OptionMonadError.handleErrorWith(Kind<Option<?>,A> value, Function1<? super Unit,? extends Kind<Option<?>,? extends A>> handler)
private <T, R> Trampoline<Kind<Option<?>,R>>	OptionMonad.loop(T value, Function1<T,? extends Kind<Option<?>,Either<T,R>>> map)
default <T, R> Kind<Option<?>,R>	OptionFunctor.map(Kind<Option<?>,? extends T> value, Function1<? super T,? extends R> mapper)
default <A, B> Kind<Option<?>,Tuple2<A,B>>	OptionSemigroupal.product(Kind<Option<?>,? extends A> fa, Kind<Option<?>,? extends B> fb)
default <T, R> Kind<Option<?>,R>	OptionMonad.tailRecM(T value, Function1<T,? extends Kind<Option<?>,Either<T,R>>> map)
default <G extends Kind<G, ?>, T, R> Kind<G,Kind<Option<?>,R>>	OptionTraverse.traverse(Applicative<G> applicative, Kind<Option<?>,T> value, Function1<? super T,? extends Kind<G,? extends R>> mapper)

Uses of Option in com.github.tonivade.purefun.monad

Methods in com.github.tonivade.purefun.monad that return Option

Modifier and Type	Method	Description
Option<IO<T>>	CallStack.tryHandle(Throwable error)
Option<IO<T>>	StackItem.tryHandle(Throwable error)

Methods in com.github.tonivade.purefun.monad with parameters of type Option

Modifier and Type	Method	Description
static <T> IO<T>	IO.fromOption(Option<? extends T> task)

Method parameters in com.github.tonivade.purefun.monad with type arguments of type Option

Modifier and Type	Method	Description
static <A, B> Function1<A,IO<B>>	IO.liftOption(Function1<? super A,? extends Option<? extends B>> function)

Uses of Option in com.github.tonivade.purefun.optics

Methods in com.github.tonivade.purefun.optics that return Option

Modifier and Type	Method	Description
Option<A>	Optional.getOption(S target)
Option<A>	POptional.getOption(S target)
Option<A>	PPrism.getOption(S target)
Option<A>	Prism.getOption(S target)
Option<S>	Optional.modifyOption(S target, Operator1<A> mapper)
Option<T>	POptional.modifyOption(S target, Function1<A,B> mapper)

Methods in com.github.tonivade.purefun.optics that return types with arguments of type Option

Modifier and Type	Method	Description
Function1<S,Option<T>>	PPrism.modifyOption(Function1<A,B> mapper)
Function1<S,Option<S>>	Prism.modifyOption(Operator1<A> mapper)
Function1<S,Option<T>>	PPrism.setOption(B value)
Function1<S,Option<S>>	Prism.setOption(A value)

Method parameters in com.github.tonivade.purefun.optics with type arguments of type Option

Modifier and Type	Method	Description
static <S, A> Optional<S,A>	Optional.of(Function2<S,A,S> set, Function1<S,Option<A>> getOption)
static <S, A> Prism<S,A>	Prism.of(Function1<S,Option<A>> getOption, Function1<A,S> reverseGet)

Uses of Option in com.github.tonivade.purefun.stream

Methods in com.github.tonivade.purefun.stream that return types with arguments of type Option

Modifier and Type	Method	Description
Kind<F,Option<T>>	Cons.headOption()
Kind<F,Option<T>>	Nil.headOption()
Kind<F,Option<T>>	PureStream.headOption()
Kind<F,Option<T>>	Suspend.headOption()
Kind<F,Option<Tuple2<Kind<F,T>,PureStream<F,T>>>>	Cons.split()
Kind<F,Option<Tuple2<Kind<F,T>,PureStream<F,T>>>>	Nil.split()
Kind<F,Option<Tuple2<Kind<F,T>,PureStream<F,T>>>>	PureStream.split()
Kind<F,Option<Tuple2<Kind<F,T>,PureStream<F,T>>>>	Suspend.split()

Method parameters in com.github.tonivade.purefun.stream with type arguments of type Option

Modifier and Type	Method	Description
private <T, S> PureStream<F,T>	PureStream.Of.doUnfold(S seed, Function1<? super S,Option<Tuple2<? extends T,? extends S>>> function)
default <T, S> PureStream<F,T>	PureStream.Of.unfold(S seed, Function1<? super S,Option<Tuple2<? extends T,? extends S>>> function)
static <F extends Kind<F, ?>, T, S> PureStream<F,T>	PureStream.unfold(S seed, Function1<? super S,Option<Tuple2<? extends T,? extends S>>> function, F... reified)

Uses of Option in com.github.tonivade.purefun.transformer

Methods in com.github.tonivade.purefun.transformer that return types with arguments of type Option

Modifier and Type	Method	Description
default <R> Kind<F,Option<R>>	OptionT.flatMapF(Function1<? super T,? extends Kind<F,? extends Option<R>>> map)
Kind<F,Option<T>>	OptionT.value()

Methods in com.github.tonivade.purefun.transformer with parameters of type Option

Modifier and Type	Method	Description
static <F extends Kind<F, ?>, R> EitherT<F,Throwable,R>	EitherT.fromOption(Monad<F> monad, Option<R> value)
static <F extends Kind<F, ?>, T> OptionT<F,T>	OptionT.lift(Monad<F> monad, Option<T> value)

Method parameters in com.github.tonivade.purefun.transformer with type arguments of type Option

Modifier and Type	Method	Description
default <R> Kind<F,Option<R>>	OptionT.flatMapF(Function1<? super T,? extends Kind<F,? extends Option<R>>> map)
static <F extends Kind<F, ?>, T> OptionT<F,T>	OptionT.of(Monad<F> monad, Kind<F,Option<T>> value)

Uses of Option in com.github.tonivade.purefun.type

Classes in com.github.tonivade.purefun.type that implement Option

Modifier and Type	Class	Description
static final class	Option.None<T>
static final record	Option.Some<T>

Methods in com.github.tonivade.purefun.type that return Option

Modifier and Type	Method	Description
default <R> Option<R>	Option.ap(Kind<Option<?>,? extends Function1<? super T,? extends R>> apply)
default Option<Either<L,R>>	Either.filter(Matcher1<? super R> matcher)
default Option<T>	Option.filter(Matcher1<? super T> matcher)
default Option<Validation<E,T>>	Validation.filter(Matcher1<? super T> matcher)
default Option<Either<L,R>>	Either.filterNot(Matcher1<? super R> matcher)
default Option<T>	Option.filterNot(Matcher1<? super T> matcher)
default Option<Validation<E,T>>	Validation.filterNot(Matcher1<? super T> matcher)
default <R> Option<R>	Option.flatMap(Function1<? super T,? extends Kind<Option<?>,? extends R>> map)
static <T> Option<T>	Option.from(Optional<T> optional)
private Option<String>	Try.Failure.getMessage()
default Option<T>	Option.ifEmpty(Runnable run)
default Option<T>	Option.ifPresent(Consumer1<? super T> consumer)
default Option<L>	Either.left()
default <R> Option<R>	Option.map(Function1<? super T,? extends R> mapper)
static <A, B, Z> Option<Z>	Option.map2(Option<A> optionA, Option<B> optionB, Function2<? super A,? super B,? extends Z> mapper)
static <T> Option<T>	Option.none()
static <T> Option<T>	Option.of(Producer<? extends T> producer)
static <T> Option<T>	Option.of(T value)
default Option<T>	Option.or(Producer<Kind<Option<?>,T>> orElse)
default Option<T>	Option.orElse(Kind<Option<?>,T> orElse)
default Option<R>	Either.right()
static <T> Option<T>	Option.some(T value)
default Option<R>	Either.toOption()
static <T> Option<T>	OptionOf.toOption(Kind<Option<?>,? extends T> value)
default Option<T>	Try.toOption()

Methods in com.github.tonivade.purefun.type with parameters of type Option

Modifier and Type	Method	Description
static <A, B, Z> Option<Z>	Option.map2(Option<A> optionA, Option<B> optionB, Function2<? super A,? super B,? extends Z> mapper)

Method parameters in com.github.tonivade.purefun.type with type arguments of type Option

Modifier and Type	Method	Description
default <R> Option<R>	Option.ap(Kind<Option<?>,? extends Function1<? super T,? extends R>> apply)
default <R> Option<R>	Option.flatMap(Function1<? super T,? extends Kind<Option<?>,? extends R>> map)
default Option<T>	Option.or(Producer<Kind<Option<?>,T>> orElse)
default Option<T>	Option.orElse(Kind<Option<?>,T> orElse)
static <T> Option<T>	OptionOf.toOption(Kind<Option<?>,? extends T> value)

Uses of Option in com.github.tonivade.purefun.typeclasses

Methods in com.github.tonivade.purefun.typeclasses that return Option

Modifier and Type	Method	Description
default <A> Option<A>	Foldable.reduce(Kind<F,? extends A> value, Operator2<A> combinator)

Method parameters in com.github.tonivade.purefun.typeclasses with type arguments of type Option

Modifier and Type	Method	Description
private <A, B, C, S> Kind<F,Either<C,B>>	MonadError.repeat(Kind<F,A> value, ScheduleImpl<F,S,A,B> schedule, Function2<E,Option<B>,Kind<F,C>> orElse)
default <A, B> Kind<F,B>	MonadError.repeatOrElse(Kind<F,A> value, Schedule<F,A,B> schedule, Function2<E,Option<B>,Kind<F,B>> orElse)
default <A, B, C> Kind<F,Either<C,B>>	MonadError.repeatOrElseEither(Kind<F,A> value, Schedule<F,A,B> schedule, Function2<E,Option<B>,Kind<F,C>> orElse)