Class ValidationWarning

Represents a validation warning encountered during mutation or state validation. Warnings indicate potential issues that do not block execution but may require attention.

Inheritance

object

ValidationWarning

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Namespace: ModularityKit.Mutator.Abstractions.Results

Assembly: ModularityKit.Mutator.dll

Syntax

public sealed class ValidationWarning

Remarks

Constructs a new ValidationWarning instance.

Constructors

| Edit this page View Source

ValidationWarning(string, string, string?)

Represents a validation warning encountered during mutation or state validation. Warnings indicate potential issues that do not block execution but may require attention.

Declaration

public ValidationWarning(string path, string message, string? code = null)

Parameters

Type	Name	Description
string	path	Path to the property or field causing the warning.
string	message	Description of the warning.
string	code	Optional code for categorization or localization.

Remarks

Constructs a new ValidationWarning instance.

Exceptions

Type	Condition
ArgumentNullException	Thrown if `path` or `message` is null.

Properties

| Edit this page View Source

Code

Optional code for categorization, tracking, or localization (i18n).

Declaration

public string? Code { get; }

Property Value

Type	Description
string

Exceptions

Type	Condition
ArgumentNullException	Thrown if `path` or `message` is null.

| Edit this page View Source

Message

Human-readable description of the warning. Should clearly explain the potential issue or caution.

Declaration

public string Message { get; }

Property Value

Type	Description
string

Exceptions

Type	Condition
ArgumentNullException	Thrown if `path` or `message` is null.

| Edit this page View Source

Path

Path to the property or field that triggered the warning. Examples: "Email", "Address.City", "Wallet.Owners[0].Role".

Declaration

public string Path { get; }

Property Value

Type	Description
string

Exceptions

Type	Condition
ArgumentNullException	Thrown if `path` or `message` is null.

Methods

| Edit this page View Source

ToString()

Returns a string representation of the warning, including severity tag, path, and message.

Declaration

public override string ToString()

Returns

Type	Description
string	A human-readable string describing the warning.

Overrides

object.ToString()

Exceptions

Type	Condition
ArgumentNullException	Thrown if `path` or `message` is null.