Class Result
- Namespace
- NuvTools.Common.ResultWrapper
- Assembly
- NuvTools.Common.dll
Represents a non-generic operation result, containing the outcome of an operation, associated messages, and status information.
public class Result : ResultBase, IResult- Inheritance
-
Result
- Implements
- Inherited Members
- Extension Methods
Examples
Example usage:
IResult result = Result.Success("Operation completed successfully.");
if (!result.Succeeded)
{
logger.LogError(result.Message);
}Remarks
This class is used to represent the result of operations that do not return data. It provides static factory methods to easily create success, validation failure, or error results, optionally with message details and logging support.
Methods
Fail(MessageDetail, ILogger?)
Creates an error result from a single MessageDetail instance.
public static IResult Fail(MessageDetail message, ILogger? logger = null)Parameters
messageMessageDetailThe message describing the failure.
loggerILoggerAn optional ILogger to log the failure.
Returns
Fail(List<MessageDetail>?, ILogger?)
Creates an error result with optional message details and logging.
public static IResult Fail(List<MessageDetail>? messages = null, ILogger? logger = null)Parameters
messagesList<MessageDetail>A list of MessageDetail objects providing error information.
loggerILoggerAn optional ILogger to log the failure.
Returns
Fail(List<string>, ILogger?)
Creates an error result from a list of simple message strings.
public static IResult Fail(List<string> messages, ILogger? logger = null)Parameters
messagesList<string>A list of message strings describing the failure.
loggerILoggerAn optional ILogger to log the failure.
Returns
Fail(Exception, short, ILogger?)
Creates an error result based on an exception, optionally logging it.
public static IResult Fail(Exception exception, short level = 1, ILogger? logger = null)Parameters
exceptionExceptionThe exception that caused the failure.
levelshortSpecifies how many inner exception levels should be aggregated.
loggerILoggerAn optional ILogger to log the exception.
Returns
Fail(string, ILogger?)
Creates an error result from a single message string.
public static IResult Fail(string message, ILogger? logger = null)Parameters
messagestringA short message describing the failure.
loggerILoggerAn optional ILogger to log the failure.
Returns
FailNotFound(string)
Creates a failure result representing a "Not Found" condition (HTTP 404).
public static IResult FailNotFound(string message)Parameters
messagestringThe message describing the missing resource.
Returns
Success(MessageDetail?)
Creates a successful operation result, optionally with a message.
public static IResult Success(MessageDetail? message = null)Parameters
messageMessageDetailAn optional message describing the success.
Returns
Success(string)
Creates a successful operation result with a simple message string.
public static IResult Success(string message)Parameters
messagestring
Returns
ValidationFail(MessageDetail, ILogger?)
Creates a validation failure result from a single MessageDetail.
public static IResult ValidationFail(MessageDetail message, ILogger? logger = null)Parameters
messageMessageDetailloggerILogger
Returns
ValidationFail(List<MessageDetail>, ILogger?)
Creates a validation failure result with detailed validation messages.
public static IResult ValidationFail(List<MessageDetail> messages, ILogger? logger = null)Parameters
messagesList<MessageDetail>A list of validation error messages.
loggerILoggerAn optional ILogger for logging the validation errors.
Returns
ValidationFail(List<string>, ILogger?)
Creates a validation failure result from a list of message strings.
public static IResult ValidationFail(List<string> messages, ILogger? logger = null)Parameters
Returns
ValidationFail(string, ILogger?)
Creates a validation failure result from a single message string.
public static IResult ValidationFail(string message, ILogger? logger = null)