Add support for IUtf8SpanFormattable and IUtf8SpanParsable (#119)

andrewlock · Dec 1, 2023 · e386666 · e386666
1 parent 63d6de0
commit e386666
Show file tree

Hide file tree

Showing 19 changed files with 384 additions and 13 deletions.
diff --git a/src/StronglyTypedIds.Templates/guid-full.typedid b/src/StronglyTypedIds.Templates/guid-full.typedid
@@ -7,6 +7,9 @@
 #endif
 #if NET7_0_OR_GREATER
         global::System.IParsable<PLACEHOLDERID>, global::System.ISpanParsable<PLACEHOLDERID>,
+#endif
+#if NET8_0_OR_GREATER
+            global::System.IUtf8SpanFormattable,
 #endif
         global::System.IComparable<PLACEHOLDERID>, global::System.IEquatable<PLACEHOLDERID>, global::System.IFormattable
     {
@@ -203,6 +206,16 @@
             global::System.ReadOnlySpan<char> format = default)
             => Value.TryFormat(destination, out charsWritten, format);
 #endif
+#if NET8_0_OR_GREATER
+            /// <inheritdoc cref="global::System.IUtf8SpanFormattable.TryFormat" />
+            public bool TryFormat(
+                global::System.Span<byte> utf8Destination,
+                out int bytesWritten,
+                [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+                global::System.ReadOnlySpan<char> format,
+                global::System.IFormatProvider? provider)
+                => Value.TryFormat(utf8Destination, out bytesWritten, format);
+#endif
 
         public partial class DapperTypeHandler : global::Dapper.SqlMapper.TypeHandler<PLACEHOLDERID>
         {

diff --git a/src/StronglyTypedIds.Templates/int-full.typedid b/src/StronglyTypedIds.Templates/int-full.typedid
@@ -7,6 +7,9 @@
 #endif
 #if NET7_0_OR_GREATER
         global::System.IParsable<PLACEHOLDERID>, global::System.ISpanParsable<PLACEHOLDERID>,
+#endif
+#if NET8_0_OR_GREATER
+            global::System.IUtf8SpanParsable<PLACEHOLDERID>, global::System.IUtf8SpanFormattable,
 #endif
         global::System.IComparable<PLACEHOLDERID>, global::System.IEquatable<PLACEHOLDERID>, global::System.IFormattable
     {
@@ -136,7 +139,7 @@
         /// <inheritdoc cref="global::System.IFormattable"/>
         public string ToString(
 #if NET7_0_OR_GREATER
-            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
 #endif
             string? format,
             global::System.IFormatProvider? formatProvider)
@@ -182,7 +185,7 @@
             global::System.Span<char> destination,
             out int charsWritten,
 #if NET7_0_OR_GREATER
-            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
 #endif
             global::System.ReadOnlySpan<char> format,
             global::System.IFormatProvider? provider)
@@ -193,11 +196,38 @@
             global::System.Span<char> destination,
             out int charsWritten,
 #if NET7_0_OR_GREATER
-            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
 #endif
             global::System.ReadOnlySpan<char> format = default)
             => Value.TryFormat(destination, out charsWritten, format);
 #endif
+#if NET8_0_OR_GREATER
+            /// <inheritdoc cref="global::System.IUtf8SpanFormattable.TryFormat" />
+            public bool TryFormat(
+                global::System.Span<byte> utf8Destination,
+                out int bytesWritten,
+                [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
+                global::System.ReadOnlySpan<char> format = default,
+                global::System.IFormatProvider? provider = null)
+                => Value.TryFormat(utf8Destination, out bytesWritten, format, provider);
+
+            /// <inheritdoc cref="global::System.IUtf8SpanParsable{TSelf}.Parse(global::System.ReadOnlySpan{byte}, global::System.IFormatProvider?)" />
+            public static PLACEHOLDERID Parse(global::System.ReadOnlySpan<byte> utf8Text, global::System.IFormatProvider? provider)
+                => new(int.Parse(utf8Text, provider));
+
+            /// <inheritdoc cref="global::System.IUtf8SpanParsable{TSelf}.TryParse(global::System.ReadOnlySpan{byte}, global::System.IFormatProvider?, out TSelf)" />
+            public static bool TryParse(global::System.ReadOnlySpan<byte> utf8Text, global::System.IFormatProvider? provider, out PLACEHOLDERID result)
+            {
+                if (int.TryParse(utf8Text, provider, out var intResult))
+                {
+                    result = new PLACEHOLDERID(intResult);
+                    return true;
+                }
+
+                result = default;
+                return false;
+            }
+#endif
 
         public partial class DapperTypeHandler : global::Dapper.SqlMapper.TypeHandler<PLACEHOLDERID>
         {

diff --git a/src/StronglyTypedIds.Templates/long-full.typedid b/src/StronglyTypedIds.Templates/long-full.typedid
@@ -7,6 +7,9 @@
 #endif
 #if NET7_0_OR_GREATER
         global::System.IParsable<PLACEHOLDERID>, global::System.ISpanParsable<PLACEHOLDERID>,
+#endif
+#if NET8_0_OR_GREATER
+            global::System.IUtf8SpanParsable<PLACEHOLDERID>, global::System.IUtf8SpanFormattable,
 #endif
         global::System.IComparable<PLACEHOLDERID>, global::System.IEquatable<PLACEHOLDERID>, global::System.IFormattable
     {
@@ -136,7 +139,7 @@
         /// <inheritdoc cref="global::System.IFormattable"/>
         public string ToString(
 #if NET7_0_OR_GREATER
-            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
 #endif
             string? format,
             global::System.IFormatProvider? formatProvider)
@@ -182,7 +185,7 @@
             global::System.Span<char> destination,
             out int charsWritten,
 #if NET7_0_OR_GREATER
-            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
 #endif
             global::System.ReadOnlySpan<char> format,
             global::System.IFormatProvider? provider)
@@ -193,12 +196,38 @@
             global::System.Span<char> destination,
             out int charsWritten,
 #if NET7_0_OR_GREATER
-            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
 #endif
             global::System.ReadOnlySpan<char> format = default)
             => Value.TryFormat(destination, out charsWritten, format);
 #endif
-
+#if NET8_0_OR_GREATER
+            /// <inheritdoc cref="global::System.IUtf8SpanFormattable.TryFormat" />
+            public bool TryFormat(
+                global::System.Span<byte> utf8Destination,
+                out int bytesWritten,
+                [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
+                global::System.ReadOnlySpan<char> format = default,
+                global::System.IFormatProvider? provider = null)
+                => Value.TryFormat(utf8Destination, out bytesWritten, format, provider);
+
+            /// <inheritdoc cref="global::System.IUtf8SpanParsable{TSelf}.Parse(global::System.ReadOnlySpan{byte}, global::System.IFormatProvider?)" />
+            public static PLACEHOLDERID Parse(global::System.ReadOnlySpan<byte> utf8Text, global::System.IFormatProvider? provider)
+                => new(long.Parse(utf8Text, provider));
+
+            /// <inheritdoc cref="global::System.IUtf8SpanParsable{TSelf}.TryParse(global::System.ReadOnlySpan{byte}, global::System.IFormatProvider?, out TSelf)" />
+            public static bool TryParse(global::System.ReadOnlySpan<byte> utf8Text, global::System.IFormatProvider? provider, out PLACEHOLDERID result)
+            {
+                if (long.TryParse(utf8Text, provider, out var intResult))
+                {
+                    result = new PLACEHOLDERID(intResult);
+                    return true;
+                }
+
+                result = default;
+                return false;
+            }
+#endif
         public partial class DapperTypeHandler : global::Dapper.SqlMapper.TypeHandler<PLACEHOLDERID>
         {
             public override void SetValue(global::System.Data.IDbDataParameter parameter, PLACEHOLDERID value)

diff --git a/src/StronglyTypedIds/EmbeddedSources.Guid.cs b/src/StronglyTypedIds/EmbeddedSources.Guid.cs
@@ -9,6 +9,9 @@ partial struct PLACEHOLDERID :
     #endif
     #if NET7_0_OR_GREATER
             global::System.IParsable<PLACEHOLDERID>, global::System.ISpanParsable<PLACEHOLDERID>,
+    #endif
+    #if NET8_0_OR_GREATER
+            global::System.IUtf8SpanFormattable,
     #endif
         global::System.IComparable<PLACEHOLDERID>, global::System.IEquatable<PLACEHOLDERID>, global::System.IFormattable
         {
@@ -204,6 +207,16 @@ public bool TryFormat(
     #endif
                 global::System.ReadOnlySpan<char> format = default)
                 => Value.TryFormat(destination, out charsWritten, format);
+    #endif
+    #if NET8_0_OR_GREATER
+            /// <inheritdoc cref="global::System.IUtf8SpanFormattable.TryFormat" />
+            public bool TryFormat(
+                global::System.Span<byte> utf8Destination,
+                out int bytesWritten,
+                [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+                global::System.ReadOnlySpan<char> format,
+                global::System.IFormatProvider? provider)
+                => Value.TryFormat(utf8Destination, out bytesWritten, format);
     #endif
         }
     """;

diff --git a/src/StronglyTypedIds/EmbeddedSources.Int.cs b/src/StronglyTypedIds/EmbeddedSources.Int.cs
@@ -9,6 +9,9 @@ partial struct PLACEHOLDERID :
     #endif
     #if NET7_0_OR_GREATER
             global::System.IParsable<PLACEHOLDERID>, global::System.ISpanParsable<PLACEHOLDERID>,
+    #endif
+    #if NET8_0_OR_GREATER
+            global::System.IUtf8SpanParsable<PLACEHOLDERID>, global::System.IUtf8SpanFormattable,
     #endif
             global::System.IComparable<PLACEHOLDERID>, global::System.IEquatable<PLACEHOLDERID>, global::System.IFormattable
         {
@@ -184,7 +187,7 @@ public bool TryFormat(
                 global::System.Span<char> destination,
                 out int charsWritten,
     #if NET7_0_OR_GREATER
-                [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+                [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
     #endif
                 global::System.ReadOnlySpan<char> format,
                 global::System.IFormatProvider? provider)
@@ -195,10 +198,37 @@ public bool TryFormat(
                 global::System.Span<char> destination,
                 out int charsWritten,
     #if NET7_0_OR_GREATER
-                [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+                [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
     #endif
                 global::System.ReadOnlySpan<char> format = default)
                 => Value.TryFormat(destination, out charsWritten, format);
+    #endif
+    #if NET8_0_OR_GREATER
+            /// <inheritdoc cref="global::System.IUtf8SpanFormattable.TryFormat" />
+            public bool TryFormat(
+                global::System.Span<byte> utf8Destination,
+                out int bytesWritten,
+                [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
+                global::System.ReadOnlySpan<char> format = default,
+                global::System.IFormatProvider? provider = null)
+                => Value.TryFormat(utf8Destination, out bytesWritten, format, provider);
+
+            /// <inheritdoc cref="global::System.IUtf8SpanParsable{TSelf}.Parse(global::System.ReadOnlySpan{byte}, global::System.IFormatProvider?)" />
+            public static PLACEHOLDERID Parse(global::System.ReadOnlySpan<byte> utf8Text, global::System.IFormatProvider? provider)
+                => new(int.Parse(utf8Text, provider));
+
+            /// <inheritdoc cref="global::System.IUtf8SpanParsable{TSelf}.TryParse(global::System.ReadOnlySpan{byte}, global::System.IFormatProvider?, out TSelf)" />
+            public static bool TryParse(global::System.ReadOnlySpan<byte> utf8Text, global::System.IFormatProvider? provider, out PLACEHOLDERID result)
+            {
+                if (int.TryParse(utf8Text, provider, out var intResult))
+                {
+                    result = new PLACEHOLDERID(intResult);
+                    return true;
+                }
+
+                result = default;
+                return false;
+            }
     #endif
         }
     """;

diff --git a/src/StronglyTypedIds/EmbeddedSources.Long.cs b/src/StronglyTypedIds/EmbeddedSources.Long.cs
@@ -9,6 +9,9 @@ partial struct PLACEHOLDERID :
     #endif
     #if NET7_0_OR_GREATER
             global::System.IParsable<PLACEHOLDERID>, global::System.ISpanParsable<PLACEHOLDERID>,
+    #endif
+    #if NET8_0_OR_GREATER
+            global::System.IUtf8SpanParsable<PLACEHOLDERID>, global::System.IUtf8SpanFormattable,
     #endif
             global::System.IComparable<PLACEHOLDERID>, global::System.IEquatable<PLACEHOLDERID>, global::System.IFormattable
         {
@@ -199,6 +202,33 @@ public bool TryFormat(
     #endif
                 global::System.ReadOnlySpan<char> format = default)
                 => Value.TryFormat(destination, out charsWritten, format);
+    #endif
+    #if NET8_0_OR_GREATER
+            /// <inheritdoc cref="global::System.IUtf8SpanFormattable.TryFormat" />
+            public bool TryFormat(
+                global::System.Span<byte> utf8Destination,
+                out int bytesWritten,
+                [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat)]
+                global::System.ReadOnlySpan<char> format = default,
+                global::System.IFormatProvider? provider = null)
+                => Value.TryFormat(utf8Destination, out bytesWritten, format, provider);
+
+            /// <inheritdoc cref="global::System.IUtf8SpanParsable{TSelf}.Parse(ReadOnlySpan{byte}, IFormatProvider?)" />
+            public static PLACEHOLDERID Parse(global::System.ReadOnlySpan<byte> utf8Text, global::System.IFormatProvider? provider)
+                => new(long.Parse(utf8Text, provider));
+
+            /// <inheritdoc cref="global::System.IUtf8SpanParsable{TSelf}.TryParse(ReadOnlySpan{byte}, IFormatProvider?, out TSelf)" />
+            public static bool TryParse(global::System.ReadOnlySpan<byte> utf8Text, global::System.IFormatProvider? provider, out PLACEHOLDERID result)
+            {
+                if (long.TryParse(utf8Text, provider, out var intResult))
+                {
+                    result = new PLACEHOLDERID(intResult);
+                    return true;
+                }
+
+                result = default;
+                return false;
+            }
     #endif
         }
     """;

diff --git a/test/StronglyTypedIds.IntegrationTests/GuidIdTests.cs b/test/StronglyTypedIds.IntegrationTests/GuidIdTests.cs
@@ -75,6 +75,23 @@ public void CantCreateEmptyGeneratedId1()
             Assert.NotEqual((object)bar, (object)foo);
         }
 
+#if NET8_0_OR_GREATER
+        [Fact]
+        public void CanFormatAsUtf8()
+        {
+            var expected = "17b4c96b-023a-4050-8ab5-4511c0e7fd09"u8;
+            var id = GuidId1.Parse("17B4C96B-023A-4050-8AB5-4511C0E7FD09");
+
+            var format = "D"; // in expected format
+            var actual = new byte[expected.Length].AsSpan();
+            var success = id.TryFormat(actual, out var charsWritten, format, provider: null);
+
+            Assert.True(success);
+            Assert.Equal(expected.Length, charsWritten);
+            Assert.True(actual.SequenceEqual(expected));
+        }
+#endif
+
         [Fact]
         public void CanSerializeToGuid_WithTypeConverter()
         {

diff --git a/test/StronglyTypedIds.IntegrationTests/IntIdTests.cs b/test/StronglyTypedIds.IntegrationTests/IntIdTests.cs
@@ -66,6 +66,22 @@ public void DifferentTypesAreUnequal()
         Assert.NotEqual((object) bar, (object) foo);
     }
 
+#if NET8_0_OR_GREATER
+    [Fact]
+    public void CanRoundTripUtf8()
+    {
+        var id = new IntId(123);
+
+        var actual = new byte[16].AsSpan();
+        Assert.True(id.TryFormat(actual, out var charsWritten));
+
+        var success = IntId.TryParse(actual.Slice(0, charsWritten), provider: null, out var result);
+
+        Assert.True(success);
+        Assert.Equal(id, result);
+    }
+#endif
+
     [Fact]
     public void CanSerializeToNullableInt_WithNewtonsoftJsonProvider()
     {

diff --git a/test/StronglyTypedIds.IntegrationTests/LongIdTests.cs b/test/StronglyTypedIds.IntegrationTests/LongIdTests.cs
@@ -65,6 +65,22 @@ public void DifferentTypesAreUnequal()
             Assert.NotEqual((object)bar, (object)foo);
         }
 
+#if NET8_0_OR_GREATER
+        [Fact]
+        public void CanRoundTripUtf8()
+        {
+            var id = new LongId(123L);
+
+            var actual = new byte[16].AsSpan();
+            Assert.True(id.TryFormat(actual, out var charsWritten));
+
+            var success = LongId.TryParse(actual.Slice(0, charsWritten), provider: null, out var result);
+
+            Assert.True(success);
+            Assert.Equal(id, result);
+        }
+#endif
+
         [Fact]
         public void CanSerializeToNullableInt_WithNewtonsoftJsonProvider()
         {

diff --git a/...napshots/StronglyTypedIdGeneratorTests.CanGenerateDefaultIdInGlobalNamespace.verified.txt b/...napshots/StronglyTypedIdGeneratorTests.CanGenerateDefaultIdInGlobalNamespace.verified.txt
@@ -18,6 +18,9 @@
 #endif
 #if NET7_0_OR_GREATER
         global::System.IParsable<MyId>, global::System.ISpanParsable<MyId>,
+#endif
+#if NET8_0_OR_GREATER
+        global::System.IUtf8SpanFormattable,
 #endif
     global::System.IComparable<MyId>, global::System.IEquatable<MyId>, global::System.IFormattable
     {
@@ -213,5 +216,15 @@
 #endif
             global::System.ReadOnlySpan<char> format = default)
             => Value.TryFormat(destination, out charsWritten, format);
+#endif
+#if NET8_0_OR_GREATER
+        /// <inheritdoc cref="global::System.IUtf8SpanFormattable.TryFormat" />
+        public bool TryFormat(
+            global::System.Span<byte> utf8Destination,
+            out int bytesWritten,
+            [global::System.Diagnostics.CodeAnalysis.StringSyntax(global::System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat)]
+            global::System.ReadOnlySpan<char> format,
+            global::System.IFormatProvider? provider)
+            => Value.TryFormat(utf8Destination, out bytesWritten, format);
 #endif
     }