Namespace: Zentient.Results Assembly: Zentient.Results.dll Available since: v0.1.0

Represents the contract for a non-generic operation result, expressing whether an operation succeeded or failed, along with structured error information, semantic status, and diagnostic messages.

This interface serves as the cornerstone of result-driven workflows in the Zentient Framework, enabling clean, consistent, and composable error-aware programming.

IResult is designed to provide a standardized, immutable, protocol-agnostic representation of the outcome of an operation without carrying a return value. It enables fluent error propagation, compositional logic, and seamless adaptation to various transport protocols (e.g., HTTP, gRPC).

Key goals and principles:

• ✅ Binary outcome clarity – IsSuccess and IsFailure offer intuitive branching.
• 📦 Structured error modeling – via ErrorInfo, compliant with application/problem+json.
• 🔌 Protocol-agnostic status – using IResultStatus for flexible mapping (e.g., HTTP status codes).
• 🧪 Diagnostics support – Messages provide rich, non-semantic context for observability.
• 🔁 Composability – designed for use with Map, Bind, Then, and other functional operations.

public interface IResult

• Type: bool
• Summary: Indicates whether the operation completed successfully.
• Behavior: Returns true if the result has no associated errors.

• Type: bool
• Summary: Indicates whether the operation failed.
• Behavior: Always the logical negation of IsSuccess.

• Type: IReadOnlyList<ErrorInfo>
• Summary: A list of structured error records explaining why the operation failed.
• Behavior: Empty when IsSuccess == true; populated otherwise.

• Type: IReadOnlyList<string>
• Summary: Optional diagnostics, debug output, or developer-facing hints.
• Behavior: Present on both success and failure. Not intended for error logic.

• Type: string?
• Summary: A shortcut to the first error’s message, if any.
• Behavior: null when the result is successful.

• Type: IResultStatus
• Summary: Provides a semantic classification of the result (e.g., ValidationError, Unauthorized).
• Behavior: Used for protocol translation and downstream response mapping.

IResult result = authService.Login(user, password);

if (result.IsSuccess)
{
    Console.WriteLine("Login successful.");
}
else
{
    Console.WriteLine($"Login failed: {result.ErrorMessage}");
    foreach (var error in result.Errors)
        Console.WriteLine($" - {error.Code}: {error.Message}");
}

• IResult is strictly non-generic. Use IResult<T> for return-value scenarios.
• Error information is always represented by ErrorInfo, never plain strings or exceptions.
• Results should be treated as immutable after creation.
• Recommended usage includes composition through functional extensions like Map, Bind, and Then.

• IResult<T>
• ErrorInfo
• IResultStatus
• Result
• Error Modeling Principles

#API #ErrorModel #FunctionalCore #Immutable #ResultPattern #FluentAPI #StableContract #ZentientCore

Last Updated: 2025-06-21 Version: 0.4.0