ktsu.io.StrongStrings
1.1.0
Prefix Reserved
dotnet add package ktsu.io.StrongStrings --version 1.1.0
NuGet\Install-Package ktsu.io.StrongStrings -Version 1.1.0
<PackageReference Include="ktsu.io.StrongStrings" Version="1.1.0" />
paket add ktsu.io.StrongStrings --version 1.1.0
#r "nuget: ktsu.io.StrongStrings, 1.1.0"
// Install ktsu.io.StrongStrings as a Cake Addin #addin nuget:?package=ktsu.io.StrongStrings&version=1.1.0 // Install ktsu.io.StrongStrings as a Cake Tool #tool nuget:?package=ktsu.io.StrongStrings&version=1.1.0
StrongStrings
A library that provides a transparent wrapper around system strings and gives you strong typing, compile time feedback, and runtime validation.
The intention is to be able to provide usage context and validation to naked strings in a similar way that Enums do for integers.
Usage
using ktsu.io.StrongStrings;
// Create a strong type by deriving a record class from StrongStringAbstract<TDerived>:
public record class MyStrongString : StrongStringAbstract<MyStrongString> { }
public class MyDemoClass
{
public MyStrongString Stronk { get; set; } = new();
public static void Demo(MyStrongString inStrongString, string inSystemString, out MyStrongString outStrongString, out string outSystemString)
{
// You can implicitly cast down to a System.String
outSystemString = inStrongString;
// You must explicitly cast up to a StrongString
outStrongString = (MyStrongString)inSystemString;
//You can provide a StrongString to a method that expects a System.String
Path.Combine(inStrongString, inSystemString);
// You can use the .WeakString property or the .ToString() method to get the value of the underlying System.String
outSystemString = inStrongString.WeakString;
outSystemString = inStrongString.ToString();
// You can not implicitly cast up to a StrongString
// outStrongString = inSystemString; // This will not compile
// You can not cast from one StrongString to another
// OtherStrongString other = inStrongString; // This will not compile
// OtherStrongString other = (OtherStrongString)inStrongString; // This will not compile either
}
}
Validation
You can provide custom validators which will throw a FormatException
at runtime to help you catch data errors.
Implement the ktsu.io.StrongStrings.IValidator
interface and provide it as a generic parameter when deriving your class:
public abstract class StartsWithHttp : IValidator
{
public static bool IsValid(AnyStrongString? strongString)
{
ArgumentNullException.ThrowIfNull(strongString);
return strongString.StartsWith("http", StringComparison.InvariantCultureIgnoreCase);
}
}
public abstract class EndsWithDotCom : IValidator
{
public static bool IsValid(AnyStrongString? strongString)
{
ArgumentNullException.ThrowIfNull(strongString);
return strongString.EndsWith(".com", StringComparison.InvariantCultureIgnoreCase);
}
}
public record class MyValidatedString : StrongStringAbstract<MyValidatedString, StartsWithHttp, EndsWithDotCom> { }
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net7.0
- No dependencies.
-
net8.0
- No dependencies.
NuGet packages (3)
Showing the top 3 NuGet packages that depend on ktsu.io.StrongStrings:
Package | Downloads |
---|---|
ktsu.io.Extensions
Extension Methods for common operations to help with expressiveness and maintainability. |
|
ktsu.io.StrongPaths
A library that provides strong typing for common filesystem paths providing compile time feedback and runtime validation. |
|
ktsu.io.AppDataStorage
Application data management library using JSON serialization to save and load data in the user's app data folder. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.1.0 | 460 | 8/21/2024 |
1.0.1 | 2,210 | 3/20/2024 |
1.0.1-alpha.1 | 58 | 3/20/2024 |
1.0.0 | 172 | 3/7/2024 |
1.0.0-alpha.8 | 71 | 2/29/2024 |
1.0.0-alpha.7 | 140 | 2/28/2024 |
1.0.0-alpha.6 | 120 | 2/18/2024 |
1.0.0-alpha.5 | 55 | 2/18/2024 |
1.0.0-alpha.4 | 202 | 12/27/2023 |
1.0.0-alpha.3 | 70 | 12/26/2023 |
1.0.0-alpha.2 | 89 | 6/1/2023 |
1.0.0-alpha.1 | 77 | 5/24/2023 |