Table of Contents

Namespace Olve.Results

Classes

DeletionResultExtensions

Extension methods for DeletionResult.

DictionaryResultExtensions

Extension methods for dictionary operations that return Result instead of throwing.

ErrorCaseAttribute

Marks a static partial factory method on a GenerateResultAttribute type as an error case. Error cases contribute to Failed and carry problems.

GenerateResultAttribute

Marks a partialstruct for which Olve.Results generates multi-state result boilerplate. Each state is declared as a static partial factory method annotated with SuccessCaseAttribute, ErrorCaseAttribute or GreyCaseAttribute. The generator emits the factory bodies, a state discriminator, per-case Is… predicates, Succeeded/Failed, and an exhaustive Match.

GreyCaseAttribute

Marks a static partial factory method on a GenerateResultAttribute type as a grey case: a state that is neither success nor failure (e.g. not-found). Grey cases make both Succeeded and Failedfalse.

MustBeUsedWhenReturnedAttribute

Marks a type whose values must always be observed when returned from a method. The Olve.Results analyzer (ORES001) reports a diagnostic when a method that returns an annotated type (directly or wrapped in Task<TResult> / ValueTask<TResult>) is invoked as a statement without observing the result.

NotFoundProblem

A problem signalling that the thing an operation needed does not exist (an unknown id or key). Transports can recover it by type, e.g. Olve.MinimalApi answers 404 Not Found.

ResultEnumerableExtensions

Extension methods for working with Result, Result, and Result<T> collections.

ResultExtensions

Extension methods for Result and Result<T>.

ResultFuncExtensions

Extensions for Func<T, TResult>.

ResultProblem

Represents a problem encountered during an operation.

ResultProblemCollection

Represents a collection of problems encountered during an operation.

SuccessCaseAttribute

Marks a static partial factory method on a GenerateResultAttribute type as a success case. Success cases contribute to Succeeded.

Structs

DeletionResult

Represents the result of a deletion operation, which can succeed, fail due to not being found, or fail due to an error.

ProblemOriginInformation

Represents the origin of a problem.

Result

Represents a result of an operation without a value, indicating success or failure.

Result<T>

Represents a result of an operation with a value, indicating success or failure.

Interfaces

IResultType

Common interface implemented by Result and Result<T> to enable non-reflective type checking and value extraction.