API Browser

Interface

IError

interface IError

Namespace: System
Assembly: Raven.Core.dll
Source file: Error.rvn

Inheritance: Object → IError

Describes an error with a human-readable message and an optional underlying cause.

Error types can implement this contract directly. Union-based errors can alternatively use Raven.Macros.Error to derive the same ordinary interface implementation; the macro does not change this runtime contract.

Implementing types

Documented types in this API reference. Indirect relationships are marked.

Properties

2 items
Cause: IError? Gets the lower-level error that caused this error, or `null` when this error has no causal chain. Defined by IError.Cause · Default implementation provided.
Message: string Gets a human-readable description of this error value. Defined by IError.Message · Required implementation (no default).

Methods

6 items
Extension member: Box(message: string) -> ContextError<IError> Boxes this error in a contextual error with the specified message. Extension from ErrorObjectExtensions.Box
Equals(obj: object?) -> bool Determines whether the specified object is equal to the current object. Inherited from Object.Equals
GetHashCode() -> int Serves as the default hash function. Inherited from Object.GetHashCode
GetType() -> Type Gets the System.Type of the current instance. Inherited from Object.GetType
ToString() -> string? Returns a string that represents the current object. Inherited from Object.ToString
Extension member: WithContext(message: string) -> ContextError<IError> Wraps this error with an additional contextual message. Extension from ErrorExtensions<TError>.WithContext

Operators

1 item
Static extension member: implicit conversion<T>(value: IError?) -> Optional<IError> Converts a nullable reference to `Some`, or to `None` when it is `null`. Extension from OptionalExtensions1<T>.op_Implicit