Table of Contents

Class UnifiedValidationResult

Namespace
DotCompute.Abstractions.Validation
Assembly
DotCompute.Abstractions.dll

Unified validation result that replaces all duplicate validation classes. This is the ONLY validation result implementation in the entire solution.

public sealed class UnifiedValidationResult
Inheritance
UnifiedValidationResult
Inherited Members

Properties

AllIssues

Gets all issues (errors, warnings, and information).

public IEnumerable<ValidationIssue> AllIssues { get; }

Property Value

IEnumerable<ValidationIssue>

Context

Gets the validation context if any.

public string? Context { get; init; }

Property Value

string

ErrorMessage

Gets the first error message if any.

public string? ErrorMessage { get; }

Property Value

string

Errors

Gets all validation errors.

public IReadOnlyList<ValidationIssue> Errors { get; }

Property Value

IReadOnlyList<ValidationIssue>

HasWarnings

Gets whether the validation has warnings.

public bool HasWarnings { get; }

Property Value

bool

Information

Gets all informational messages.

public IReadOnlyList<ValidationIssue> Information { get; }

Property Value

IReadOnlyList<ValidationIssue>

IsValid

Gets whether the validation passed (no errors).

public bool IsValid { get; }

Property Value

bool

Timestamp

Gets the timestamp of validation.

public DateTimeOffset Timestamp { get; }

Property Value

DateTimeOffset

Warnings

Gets all validation warnings.

public IReadOnlyList<ValidationIssue> Warnings { get; }

Property Value

IReadOnlyList<ValidationIssue>

Methods

AddError(string, string?, string?, object?)

Adds an error to the validation result.

public void AddError(string message, string? code = null, string? source = null, object? data = null)

Parameters

message string
code string
source string
data object

AddInfo(string, string?, string?, object?)

Adds an informational message to the validation result.

public void AddInfo(string message, string? code = null, string? source = null, object? data = null)

Parameters

message string
code string
source string
data object

AddWarning(string, string?, string?, object?)

Adds a warning to the validation result.

public void AddWarning(string message, string? code = null, string? source = null, object? data = null)

Parameters

message string
code string
source string
data object

Failure(string, string?)

Creates a failed validation result with a single error.

public static UnifiedValidationResult Failure(string errorMessage, string? code = null)

Parameters

errorMessage string
code string

Returns

UnifiedValidationResult

FromException(Exception)

Creates a validation result from an exception.

public static UnifiedValidationResult FromException(Exception exception)

Parameters

exception Exception

Returns

UnifiedValidationResult

GetErrorSummary()

Gets a summary message of all errors.

public string GetErrorSummary()

Returns

string

GetFullSummary()

Gets a full summary of all issues.

public string GetFullSummary()

Returns

string

Merge(UnifiedValidationResult)

Merges another validation result into this one.

public void Merge(UnifiedValidationResult other)

Parameters

other UnifiedValidationResult

Success()

Creates a successful validation result.

public static UnifiedValidationResult Success()

Returns

UnifiedValidationResult

ThrowIfInvalid()

Throws an exception if validation failed.

public void ThrowIfInvalid()