Development · Native API migration preview · Coverage validation in progress Published release →

API Browser

Union

Result<T, E>

union struct Result<T, E>

Module: System
Assembly: System.Runtime.dll
Source file: Result.rvn

Inheritance: Object → ValueType → Result<T, E>
Implements: Propagatable<Result<T, E>, T, E>

A nominal union containing a successful value or an expected error.

Remarks

Prefer Ok/Error construction, union patterns and propagation in Raven source. Expected errors remain values.

Cases

2 cases

Properties

2 items
HasValue: bool Reports whether a case is active, including an explicitly constructed empty case.
Value: object? Gets the boxed active case, or null for an inactive default carrier.

Methods

21 items
Equals(other: object?) -> bool Tests reference identity by default; an ordinary class may override equality. Inherited from Object.Equals
Static member: FromResidual(residual: E) -> Result<T, E> Constructs an error result from a propagated residual.
GetHashCode() -> int Returns a stable identity hash by default; an ordinary class may override it consistently with equality. Inherited from Object.GetHashCode
GetType() -> TypeInfo Returns metadata for the concrete runtime type of this instance. Inherited from Object.GetType
Extension member: Map<U>(mapper: (T) -> U) -> Result<U, E> No summary available. Extension from ResultOperators.Map
Extension member: MapError<F>(mapper: (E) -> F) -> Result<T, F> No summary available. Extension from ResultOperators.MapError
Extension member: Match<U>(ok: (T) -> U, error: (E) -> U) -> U No summary available. Extension from ResultOperators.Match
Extension member: OrElse(recover: (E) -> Result<T, E>) -> Result<T, E> No summary available. Extension from ResultOperators.OrElse
Extension member: Tap(action: (T) -> ()) -> Result<T, E> No summary available. Extension from ResultOperators.Tap
Extension member: TapError(action: (E) -> ()) -> Result<T, E> No summary available. Extension from ResultOperators.TapError
Extension member: Then<U>(binder: (T) -> Result<U, E>) -> Result<U, E> No summary available. Extension from ResultOperators.Then
Extension member: ToIterable() -> Iterable<T> Returns an iterable containing the successful value, or an empty iterable for absence or error. Extension from ResultOperators.ToIterable
ToString() -> string Returns the generated union case representation. Overrides Object.ToString
TryGetOutput(output: out T) -> bool Attempts to extract the successful output used by the propagation protocol. Implements Propagatable<Result<T, E>, T, E>.TryGetOutput
TryGetResidual(residual: out E) -> bool Attempts to extract the residual used by the propagation protocol. Implements Propagatable<Result<T, E>, T, E>.TryGetResidual
Extension member: UnwrapOr(defaultValue: T) -> T Returns the successful value, or the supplied fallback value. Extension from ResultOperators.UnwrapOr
Extension member: UnwrapOrElse(factory: () -> T) -> T No summary available. Extension from ResultOperators.UnwrapOrElse
Extension member: WithContext(message: () -> string, captureStackTrace: bool) -> Result<T, ContextError<E>> Evaluates the message factory and optional capture only on failure. Extension from ResultErrorContextExtensions.WithContextApplies to Result<T, E> where E: Error.
Extension member: WithContext(message: () -> string) -> Result<T, ContextError<E>> Evaluates the message factory only on failure; uses the application capture setting. Extension from ResultErrorContextExtensions.WithContextApplies to Result<T, E> where E: Error.
Extension member: WithContext(message: string, captureStackTrace: bool) -> Result<T, ContextError<E>> Preserves success and optionally captures a stack only on failure. Extension from ResultErrorContextExtensions.WithContextApplies to Result<T, E> where E: Error.
Extension member: WithContext(message: string) -> Result<T, ContextError<E>> Preserves success and wraps failure with operation context. Extension from ResultErrorContextExtensions.WithContextApplies to Result<T, E> where E: Error.