Samhammer.Validation 1.0.2

.NET Standard 2.0
dotnet add package Samhammer.Validation --version 1.0.2
NuGet\Install-Package Samhammer.Validation -Version 1.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Samhammer.Validation" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Samhammer.Validation --version 1.0.2
#r "nuget: Samhammer.Validation, 1.0.2"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Samhammer.Validation as a Cake Addin
#addin nuget:?package=Samhammer.Validation&version=1.0.2

// Install Samhammer.Validation as a Cake Tool
#tool nuget:?package=Samhammer.Validation&version=1.0.2

Usage

How to add this to your project:
Validate a model
var context = new Validation<ValidationResult>()
    .Load("test")
    .Add(SampleRule);

var result = await context.ValidateAsync();

if (!result.Succeeded)
{
    // TODO handle validation error
}

public ValidationResult SampleRule(string input)
{
    return new ValidationResult { Succeeded = input != null };
}
Validate a model, loaded by func
async Task<Model> LoadModel() => await Repository.GetById(id);

var context = new Validation<ValidationContract>()
    .Load(LoadModel)
    .Add(SampleRule);
Validate multiple models
var context1 = new Validation<ValidationResult>()
    .Load(input1)
    .Add(SampleRule);

var context2 = new Validation<ValidationResult>()
    .Load(input2)
    .Add(SampleRule2);

var result = await Validation<ValidationResult>.ValidateAllAsync(context1, context2);
Validate with custom result class

You can define your own result class with additional fields.
This can be used to add something like an errorCode or an errorMessage by your rules.

var context = new Validation<CustomValidationResult>()
    .Load(input)
    .Add(SampleRuleWithErrorCode);

var result = await context.ValidateAsync();

public static CustomValidationResult SampleRuleWithErrorCode(string input)
{
    return string.IsNullOrEmpty(input)
        ? new CustomValidationResult(ErrorCode.Error)
        : new CustomValidationResult();
}
public class CustomValidationResult : ValidationResult
{
    public ErrorCode ErrorCode { get; set; }

    public CustomValidationResult()
    {
        Succeeded = true;
    }

    public CustomValidationResult(ErrorCode errorCode)
    {
        Succeeded = false;
        ErrorCode = errorCode;
    }
}

public enum ErrorCode
{
    Ok,
    Error,
}

Contribute

How to publish package
  • Create a tag and let the github action do the publishing for you
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 2,136 1/20/2022
1.0.1 5,433 1/16/2020
1.0.0 394 1/15/2020