Uses of Class
org.storynode.pigeon.result.Result

Packages that use Result

Package	Description
org.storynode.pigeon.assertion	Assertions for Option, Result and other types
org.storynode.pigeon.function	Static classes exposing functions
org.storynode.pigeon.protocol
org.storynode.pigeon.result	Types representing the outcome of some operations
org.storynode.pigeon.wrap	Generic wrapper types

Uses of Result in org.storynode.pigeon.assertion

Methods in org.storynode.pigeon.assertion with parameters of type Result

Modifier and Type	Method	Description
static <T, E> @NotNull ResultAssert<T,E>	Assertions.assertThat(Result<T,E> actual)	assertThat.

Method parameters in org.storynode.pigeon.assertion with type arguments of type Result

Modifier and Type	Method	Description
<U> ResultAssert<T,E>	ResultAssert.returns(U expected, @NotNull Function<Result<T,E>,U> provider)	Asserts that the provided function returns expected

Constructors in org.storynode.pigeon.assertion with parameters of type Result

Modifier	Constructor	Description
	ResultAssert(Result<T,E> teResult)	Constructor for ResultAssert.

Uses of Result in org.storynode.pigeon.function

Methods in org.storynode.pigeon.function that return Result

Modifier and Type	Method	Description
static @NotNull Result<None<?>,Exception>	NeverThrow.executing(Runnable func)	Runs the given function and returns a Result describing its outcome
static <T> @NotNull Result<T,? extends Throwable>	NeverThrow.executing(ThrowingSupplier<T> func)	Runs the given function and returns a Result with the function returned value

Uses of Result in org.storynode.pigeon.protocol

Methods in org.storynode.pigeon.protocol that return Result

Modifier and Type	Method	Description
default Result<T,? extends Throwable>	SafelyWrapped.tryUnwrap()	The non-throwing variant of Wrapped.unwrap().

Uses of Result in org.storynode.pigeon.result

Subclasses of Result in org.storynode.pigeon.result

Modifier and Type	Class	Description
class	Err<T,E>	Result variant for errors.
class	Ok<T,E>	Result variant for ok values.

Methods in org.storynode.pigeon.result that return Result

Modifier and Type	Method	Description
<U> Result<U,E>	Err.and(Result<U,E> res)	Returns res if the result is Ok, otherwise returns the Err value of this.
<U> Result<U,E>	Ok.and(Result<U,E> res)	Returns res if the result is Ok, otherwise returns the Err value of this.
abstract <U> Result<U,E>	Result.and(Result<U,E> res)	Returns res if the result is Ok, otherwise returns the Err value of this.
<U> Result<U,E>	Err.andThen(Function<T,Result<U,E>> res)	Like and(Result) but lazily evaluated.
<U> Result<U,E>	Ok.andThen(Function<T,Result<U,E>> res)	Like and(Result) but lazily evaluated.
abstract <U> Result<U,E>	Result.andThen(Function<T,Result<U,E>> res)	Like and(Result) but lazily evaluated.
static <T, E> @NotNull Result<T,E>	Result.err(E error)	Constructs an error variant of a Result
static <T, E> @NotNull Result<T,E>	Result.error(E error)	Constructs an error variant of a Result
<U> Result<U,E>	Err.flatMap(@NotNull Function<? super T,? extends Result<U,E>> fn)	Like Option.map(Function) but does not re-wrap the result of the provided mapping function to a Result
<U> Result<U,E>	Ok.flatMap(@NotNull Function<? super T,? extends Result<U,E>> fn)	Like Option.map(Function) but does not re-wrap the result of the provided mapping function to a Result
abstract <U> Result<U,E>	Result.flatMap(@NotNull Function<? super T,? extends Result<U,E>> fn)	Like Option.map(Function) but does not re-wrap the result of the provided mapping function to a Result
Result<T,E>	Result.ifError(Consumer<E> whenError)	Executes the provided function if this contains an error
Result<T,E>	Result.ifOk(Consumer<T> whenOk)	Executes the provided function if this contains a value
Result<T,E>	Err.ifOkOrElse(Consumer<T> whenOk, @NotNull Consumer<E> whenError)	Executes whenOk if this contains a value, whenError otherwise.
Result<T,E>	Ok.ifOkOrElse(@NotNull Consumer<T> whenOk, Consumer<E> whenError)	Executes whenOk if this contains a value, whenError otherwise.
abstract Result<T,E>	Result.ifOkOrElse(Consumer<T> whenOk, Consumer<E> whenError)	Executes whenOk if this contains a value, whenError otherwise.
<U> Result<U,E>	Err.map(@NotNull Function<? super T,? extends U> fn)	Maps a Result<T, E> to Result<U, E> by applying a function to a contained value, leaving a result that contains an error untouched.
<U> Result<U,E>	Ok.map(@NotNull Function<? super T,? extends U> fn)	Maps a Result<T, E> to Result<U, E> by applying a function to a contained value, leaving a result that contains an error untouched.
abstract <U> Result<U,E>	Result.map(@NotNull Function<? super T,? extends U> fn)	Maps a Result<T, E> to Result<U, E> by applying a function to a contained value, leaving a result that contains an error untouched.
<U> Result<T,U>	Err.mapError(@NotNull Function<? super E,? extends U> fn)	Maps a Result<T, E> to Result<T, U> by applying a function to a contained error, leaving a result that contains a value untouched.
<U> Result<T,U>	Ok.mapError(@NotNull Function<? super E,? extends U> fn)	Maps a Result<T, E> to Result<T, U> by applying a function to a contained error, leaving a result that contains a value untouched.
abstract <U> Result<T,U>	Result.mapError(Function<? super E,? extends U> fn)	Maps a Result<T, E> to Result<T, U> by applying a function to a contained error, leaving a result that contains a value untouched.
static <T, E extends Throwable> @NotNull Result<T,E>	Result.of(ThrowingSupplier<T> fn)	Constructs a new Result by using the provided function return value.
static <T, E> @NotNull Result<T,E>	Result.ok(T inner)	Constructs an ok variant of a Result.

Methods in org.storynode.pigeon.result with parameters of type Result

Modifier and Type	Method	Description
<U> Result<U,E>	Err.and(Result<U,E> res)	Returns res if the result is Ok, otherwise returns the Err value of this.
<U> Result<U,E>	Ok.and(Result<U,E> res)	Returns res if the result is Ok, otherwise returns the Err value of this.
abstract <U> Result<U,E>	Result.and(Result<U,E> res)	Returns res if the result is Ok, otherwise returns the Err value of this.

Method parameters in org.storynode.pigeon.result with type arguments of type Result

Modifier and Type	Method	Description
<U> Result<U,E>	Err.andThen(Function<T,Result<U,E>> res)	Like and(Result) but lazily evaluated.
<U> Result<U,E>	Ok.andThen(Function<T,Result<U,E>> res)	Like and(Result) but lazily evaluated.
abstract <U> Result<U,E>	Result.andThen(Function<T,Result<U,E>> res)	Like and(Result) but lazily evaluated.
<U> Result<U,E>	Err.flatMap(@NotNull Function<? super T,? extends Result<U,E>> fn)	Like Option.map(Function) but does not re-wrap the result of the provided mapping function to a Result
<U> Result<U,E>	Ok.flatMap(@NotNull Function<? super T,? extends Result<U,E>> fn)	Like Option.map(Function) but does not re-wrap the result of the provided mapping function to a Result
abstract <U> Result<U,E>	Result.flatMap(@NotNull Function<? super T,? extends Result<U,E>> fn)	Like Option.map(Function) but does not re-wrap the result of the provided mapping function to a Result

Uses of Result in org.storynode.pigeon.wrap

Methods in org.storynode.pigeon.wrap that return Result

Modifier and Type	Method	Description
static <T> @NotNull Result<Metadata<T>,? extends Throwable>	Metadata.from(@NotNull Wrapped<T> wrapped)	Tries to create a Metadata instance from another Wrapped value.
static <T> @NotNull Result<Metadata<T>,? extends Throwable>	Metadata.from(@NotNull Wrapped<T> wrapped, Map<Object,Object> additionalMetadata)	Tries to create a Metadata instance from another Wrapped value.