Make String.{Try}CopyTo public (#53246)

stephentoub · web-flow · commit 6c4f45c087bc · 2021-05-26T06:51:21.000-04:00
diff --git a/src/libraries/Common/src/System/Net/SocketAddress.cs b/src/libraries/Common/src/System/Net/SocketAddress.cs
@@ -251,7 +251,7 @@ public override string ToString()
                 stackalloc char[256] :
                 new char[maxLength];
 
-            familyString.AsSpan().CopyTo(result);
+            familyString.CopyTo(result);
             int length = familyString.Length;
 
             result[length++] = ':';
diff --git a/src/libraries/Common/src/System/Text/ValueStringBuilder.cs b/src/libraries/Common/src/System/Text/ValueStringBuilder.cs
@@ -158,10 +158,9 @@ public void Insert(int index, string? s)
 
             int remaining = _pos - index;
             _chars.Slice(index, remaining).CopyTo(_chars.Slice(index + count));
-#if SYSTEM_PRIVATE_CORELIB
             s
-#else
-            s.AsSpan()
+#if !NET6_0_OR_GREATER
+                .AsSpan()
 #endif
                 .CopyTo(_chars.Slice(index));
             _pos += count;
@@ -210,10 +209,9 @@ private void AppendSlow(string s)
                 Grow(s.Length);
             }
 
-#if SYSTEM_PRIVATE_CORELIB
             s
-#else
-            s.AsSpan()
+#if !NET6_0_OR_GREATER
+                .AsSpan()
 #endif
                 .CopyTo(_chars.Slice(pos));
             _pos += s.Length;
diff --git a/src/libraries/Common/tests/Tests/System/StringTests.cs b/src/libraries/Common/tests/Tests/System/StringTests.cs
@@ -482,6 +482,42 @@ public static void CopyTo_Invalid()
             AssertExtensions.Throws<ArgumentOutOfRangeException>("sourceIndex", () => s.CopyTo(0, dst, 0, 6));
         }
 
+        [Theory]
+        [InlineData("", 0)]
+        [InlineData("", 1)]
+        [InlineData("a", 1)]
+        [InlineData("a", 0)]
+        [InlineData("a", 2)]
+        [InlineData("abc", 2)]
+        [InlineData("abc", 3)]
+        [InlineData("abc", 4)]
+        [InlineData("Hello world", 20)]
+        public static void CopyTo_Span(string s, int destinationLength)
+        {
+            char[] destination = new char[destinationLength];
+
+            if (s.Length > destinationLength)
+            {
+                AssertExtensions.Throws<ArgumentException>("destination", () => s.CopyTo(destination));
+                Assert.All(destination, c => Assert.Equal(0, c));
+
+                Assert.False(s.TryCopyTo(destination));
+                Assert.All(destination, c => Assert.Equal(0, c));
+            }
+            else
+            {
+                s.CopyTo(destination);
+                Assert.Equal(s, new Span<char>(destination, 0, s.Length).ToString());
+                Assert.All(destination.AsSpan(s.Length).ToArray(), c => Assert.Equal(0, c));
+
+                Array.Clear(destination, 0, destination.Length);
+
+                Assert.True(s.TryCopyTo(destination));
+                Assert.Equal(s, new Span<char>(destination, 0, s.Length).ToString());
+                Assert.All(destination.AsSpan(s.Length).ToArray(), c => Assert.Equal(0, c));
+            }
+        }
+
         public static IEnumerable<object[]> Compare_TestData()
         {
             // CurrentCulture
diff --git a/src/libraries/System.Diagnostics.TextWriterTraceListener/src/System/Diagnostics/XmlWriterTraceListener.cs b/src/libraries/System.Diagnostics.TextWriterTraceListener/src/System/Diagnostics/XmlWriterTraceListener.cs
@@ -71,14 +71,14 @@ public override void Fail(string? message, string? detailMessage)
             TraceEvent(null, SR.TraceAsTraceSource, TraceEventType.Error, 0, string.Create(length, (message, detailMessage),
             (dst, v) =>
             {
-                ReadOnlySpan<char> prefix = v.message;
+                string prefix = v.message;
                 prefix.CopyTo(dst);
 
                 if (v.detailMessage != null)
                 {
                     dst[prefix.Length] = ' ';
 
-                    ReadOnlySpan<char> detail = v.detailMessage;
+                    string detail = v.detailMessage;
                     detail.CopyTo(dst.Slice(prefix.Length + 1, detail.Length));
                 }
             }));
diff --git a/src/libraries/System.Private.CoreLib/src/System/String.cs b/src/libraries/System.Private.CoreLib/src/System/String.cs
@@ -461,14 +461,11 @@ public unsafe void CopyTo(int sourceIndex, char[] destination, int destinationIn
                 elementCount: (uint)count);
         }
 
-        // TODO: https://github.com/dotnet/runtime/issues/51061
-        // Make these {Try}CopyTo methods public and use throughout dotnet/runtime.
-
         /// <summary>Copies the contents of this string into the destination span.</summary>
         /// <param name="destination">The span into which to copy this string's contents.</param>
         /// <exception cref="System.ArgumentException">The destination span is shorter than the source string.</exception>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal void CopyTo(Span<char> destination)
+        public void CopyTo(Span<char> destination)
         {
             if ((uint)Length <= (uint)destination.Length)
             {
@@ -484,7 +481,7 @@ internal void CopyTo(Span<char> destination)
         /// <param name="destination">The span into which to copy this string's contents.</param>
         /// <returns>true if the data was copied; false if the destination was too short to fit the contents of the string.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal bool TryCopyTo(Span<char> destination)
+        public bool TryCopyTo(Span<char> destination)
         {
             bool retVal = false;
             if ((uint)Length <= (uint)destination.Length)
diff --git a/src/libraries/System.Private.Xml/src/System/Xml/Serialization/CodeIdentifier.cs b/src/libraries/System.Private.Xml/src/System/Xml/Serialization/CodeIdentifier.cs
@@ -35,7 +35,7 @@ public static string MakePascal(string identifier)
             {
                 return string.Create(identifier.Length, identifier, static (buffer, identifier) =>
                 {
-                    identifier.AsSpan().CopyTo(buffer);
+                    identifier.CopyTo(buffer);
                     buffer[0] = char.ToUpperInvariant(buffer[0]); // convert only first char to uppercase; leave all else as-is
                 });
             }
@@ -59,7 +59,7 @@ public static string MakeCamel(string identifier)
             {
                 return string.Create(identifier.Length, identifier, static (buffer, identifier) =>
                 {
-                    identifier.AsSpan().CopyTo(buffer);
+                    identifier.CopyTo(buffer);
                     buffer[0] = char.ToLowerInvariant(buffer[0]); // convert only first char to lowercase; leave all else as-is
                 });
             }
diff --git a/src/libraries/System.Runtime/ref/System.Runtime.cs b/src/libraries/System.Runtime/ref/System.Runtime.cs
@@ -3632,6 +3632,7 @@ public unsafe String(sbyte* value, int startIndex, int length, System.Text.Encod
         [System.ObsoleteAttribute("This API should not be used to create mutable strings. See https://go.microsoft.com/fwlink/?linkid=2084035 for alternatives.")]
         public static System.String Copy(System.String str) { throw null; }
         public void CopyTo(int sourceIndex, char[] destination, int destinationIndex, int count) { }
+        public void CopyTo(System.Span<char> destination) { }
         public static System.String Create<TState>(int length, TState state, System.Buffers.SpanAction<char, TState> action) { throw null; }
         public bool EndsWith(char value) { throw null; }
         public bool EndsWith(System.String value) { throw null; }
@@ -3767,6 +3768,7 @@ public void CopyTo(int sourceIndex, char[] destination, int destinationIndex, in
         public System.String TrimStart() { throw null; }
         public System.String TrimStart(char trimChar) { throw null; }
         public System.String TrimStart(params char[]? trimChars) { throw null; }
+        public bool TryCopyTo(System.Span<char> destination) { throw null; }
     }
     public abstract partial class StringComparer : System.Collections.Generic.IComparer<string?>, System.Collections.Generic.IEqualityComparer<string?>, System.Collections.IComparer, System.Collections.IEqualityComparer
     {
diff --git a/src/libraries/System.Security.Cryptography.Encoding/src/System/Security/Cryptography/PemEncoding.cs b/src/libraries/System.Security.Cryptography.Encoding/src/System/Security/Cryptography/PemEncoding.cs
@@ -168,9 +168,9 @@ static ReadOnlySpan<char> WritePostEB(ReadOnlySpan<char> label, Span<char> desti
             {
                 int size = PostEBPrefix.Length + label.Length + Ending.Length;
                 Debug.Assert(destination.Length >= size);
-                PostEBPrefix.AsSpan().CopyTo(destination);
+                PostEBPrefix.CopyTo(destination);
                 label.CopyTo(destination.Slice(PostEBPrefix.Length));
-                Ending.AsSpan().CopyTo(destination.Slice(PostEBPrefix.Length + label.Length));
+                Ending.CopyTo(destination.Slice(PostEBPrefix.Length + label.Length));
                 return destination.Slice(0, size);
             }
         }
diff --git a/src/libraries/System.Security.Cryptography.X509Certificates/src/Internal/Cryptography/Pal.Unix/OpenSslX509ChainProcessor.cs b/src/libraries/System.Security.Cryptography.X509Certificates/src/Internal/Cryptography/Pal.Unix/OpenSslX509ChainProcessor.cs
@@ -740,7 +740,7 @@ private static string UrlPathAppend(string baseUri, ReadOnlyMemory<char> resourc
                     (baseUri, resource),
                     (buf, st) =>
                     {
-                        st.baseUri.AsSpan().CopyTo(buf);
+                        st.baseUri.CopyTo(buf);
                         st.resource.Span.CopyTo(buf.Slice(st.baseUri.Length));
                     });
             }
@@ -750,7 +750,7 @@ private static string UrlPathAppend(string baseUri, ReadOnlyMemory<char> resourc
                 (baseUri, resource),
                 (buf, st) =>
                 {
-                    st.baseUri.AsSpan().CopyTo(buf);
+                    st.baseUri.CopyTo(buf);
                     buf[st.baseUri.Length] = '/';
                     st.resource.Span.CopyTo(buf.Slice(st.baseUri.Length + 1));
                 });
diff --git a/src/libraries/System.Text.Json/src/System/Text/Json/Serialization/JsonCamelCaseNamingPolicy.cs b/src/libraries/System.Text.Json/src/System/Text/Json/Serialization/JsonCamelCaseNamingPolicy.cs
@@ -15,7 +15,11 @@ public override string ConvertName(string name)
 #if BUILDING_INBOX_LIBRARY
             return string.Create(name.Length, name, (chars, name) =>
             {
-                name.AsSpan().CopyTo(chars);
+                name
+#if !NET6_0_OR_GREATER
+                .AsSpan()
+#endif
+                .CopyTo(chars);
                 FixCasing(chars);
             });
 #else
diff --git a/src/libraries/System.Text.RegularExpressions/src/System/Text/RegularExpressions/RegexCharClass.cs b/src/libraries/System.Text.RegularExpressions/src/System/Text/RegularExpressions/RegexCharClass.cs
@@ -576,11 +576,11 @@ public static string ConvertOldStringsToClass(string set, string category)
                     span[FlagsIndex] = '\0';
                     span[SetLengthIndex] = (char)state.set.Length;
                     span[CategoryLengthIndex] = (char)state.category.Length;
-                    state.set.AsSpan().CopyTo(span.Slice(SetStartIndex));
+                    state.set.CopyTo(span.Slice(SetStartIndex));
                     index = SetStartIndex + state.set.Length;
                 }
 
-                state.category.AsSpan().CopyTo(span.Slice(index));
+                state.category.CopyTo(span.Slice(index));
             });
         }
 
diff --git a/src/libraries/System.Web.HttpUtility/src/System/Web/Util/Utf16StringValidator.cs b/src/libraries/System.Web.HttpUtility/src/System/Web/Util/Utf16StringValidator.cs
@@ -34,7 +34,7 @@ internal static string ValidateString(string input)
             // slow case: surrogates exist, so we need to validate them
             return string.Create(input.Length, (input, idxOfFirstSurrogate), (chars, state) =>
             {
-                state.input.AsSpan().CopyTo(chars);
+                state.input.CopyTo(chars);
                 for (int i = state.idxOfFirstSurrogate; i < chars.Length; i++)
                 {
                     char thisChar = chars[i];

Original file line number	Diff line number	Diff line change
`@@ -71,14 +71,14 @@ public override void Fail(string? message, string? detailMessage)`
`71`	`71`	`TraceEvent(null, SR.TraceAsTraceSource, TraceEventType.Error, 0, string.Create(length, (message, detailMessage),`
`72`	`72`	`(dst, v) =>`
`73`	`73`	`{`
`74`		`- ReadOnlySpan<char> prefix = v.message;`
	`74`	`+ string prefix = v.message;`
`75`	`75`	`prefix.CopyTo(dst);`
`76`	`76`
`77`	`77`	`if (v.detailMessage != null)`
`78`	`78`	`{`
`79`	`79`	`dst[prefix.Length] = ' ';`
`80`	`80`
`81`		`- ReadOnlySpan<char> detail = v.detailMessage;`
	`81`	`+ string detail = v.detailMessage;`
`82`	`82`	`detail.CopyTo(dst.Slice(prefix.Length + 1, detail.Length));`
`83`	`83`	`}`
`84`	`84`	`}));`
Original file line number	Diff line number	Diff line change
`@@ -461,14 +461,11 @@ public unsafe void CopyTo(int sourceIndex, char[] destination, int destinationIn`
`461`	`461`	`elementCount: (uint)count);`
`462`	`462`	`}`
`463`	`463`
`464`		`- // TODO: https://github.com/dotnet/runtime/issues/51061`
`465`		`- // Make these {Try}CopyTo methods public and use throughout dotnet/runtime.`
`466`		`-`
`467`	`464`	`/// <summary>Copies the contents of this string into the destination span.</summary>`
`468`	`465`	`/// <param name="destination">The span into which to copy this string's contents.</param>`
`469`	`466`	`/// <exception cref="System.ArgumentException">The destination span is shorter than the source string.</exception>`
`470`	`467`	`[MethodImpl(MethodImplOptions.AggressiveInlining)]`
`471`		`- internal void CopyTo(Span<char> destination)`
	`468`	`+ public void CopyTo(Span<char> destination)`
`472`	`469`	`{`
`473`	`470`	`if ((uint)Length <= (uint)destination.Length)`
`474`	`471`	`{`
`@@ -484,7 +481,7 @@ internal void CopyTo(Span<char> destination)`
`484`	`481`	`/// <param name="destination">The span into which to copy this string's contents.</param>`
`485`	`482`	`/// <returns>true if the data was copied; false if the destination was too short to fit the contents of the string.</returns>`
`486`	`483`	`[MethodImpl(MethodImplOptions.AggressiveInlining)]`
`487`		`- internal bool TryCopyTo(Span<char> destination)`
	`484`	`+ public bool TryCopyTo(Span<char> destination)`
`488`	`485`	`{`
`489`	`486`	`bool retVal = false;`
`490`	`487`	`if ((uint)Length <= (uint)destination.Length)`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public static string MakePascal(string identifier)`
`35`	`35`	`{`
`36`	`36`	`return string.Create(identifier.Length, identifier, static (buffer, identifier) =>`
`37`	`37`	`{`
`38`		`- identifier.AsSpan().CopyTo(buffer);`
	`38`	`+ identifier.CopyTo(buffer);`
`39`	`39`	`buffer[0] = char.ToUpperInvariant(buffer[0]); // convert only first char to uppercase; leave all else as-is`
`40`	`40`	`});`
`41`	`41`	`}`
`@@ -59,7 +59,7 @@ public static string MakeCamel(string identifier)`
`59`	`59`	`{`
`60`	`60`	`return string.Create(identifier.Length, identifier, static (buffer, identifier) =>`
`61`	`61`	`{`
`62`		`- identifier.AsSpan().CopyTo(buffer);`
	`62`	`+ identifier.CopyTo(buffer);`
`63`	`63`	`buffer[0] = char.ToLowerInvariant(buffer[0]); // convert only first char to lowercase; leave all else as-is`
`64`	`64`	`});`
`65`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -168,9 +168,9 @@ static ReadOnlySpan<char> WritePostEB(ReadOnlySpan<char> label, Span<char> desti`
`168`	`168`	`{`
`169`	`169`	`int size = PostEBPrefix.Length + label.Length + Ending.Length;`
`170`	`170`	`Debug.Assert(destination.Length >= size);`
`171`		`- PostEBPrefix.AsSpan().CopyTo(destination);`
	`171`	`+ PostEBPrefix.CopyTo(destination);`
`172`	`172`	`label.CopyTo(destination.Slice(PostEBPrefix.Length));`
`173`		`- Ending.AsSpan().CopyTo(destination.Slice(PostEBPrefix.Length + label.Length));`
	`173`	`+ Ending.CopyTo(destination.Slice(PostEBPrefix.Length + label.Length));`
`174`	`174`	`return destination.Slice(0, size);`
`175`	`175`	`}`
`176`	`176`	`}`
Original file line number	Diff line number	Diff line change
`@@ -740,7 +740,7 @@ private static string UrlPathAppend(string baseUri, ReadOnlyMemory<char> resourc`
`740`	`740`	`(baseUri, resource),`
`741`	`741`	`(buf, st) =>`
`742`	`742`	`{`
`743`		`- st.baseUri.AsSpan().CopyTo(buf);`
	`743`	`+ st.baseUri.CopyTo(buf);`
`744`	`744`	`st.resource.Span.CopyTo(buf.Slice(st.baseUri.Length));`
`745`	`745`	`});`
`746`	`746`	`}`
`@@ -750,7 +750,7 @@ private static string UrlPathAppend(string baseUri, ReadOnlyMemory<char> resourc`
`750`	`750`	`(baseUri, resource),`
`751`	`751`	`(buf, st) =>`
`752`	`752`	`{`
`753`		`- st.baseUri.AsSpan().CopyTo(buf);`
	`753`	`+ st.baseUri.CopyTo(buf);`
`754`	`754`	`buf[st.baseUri.Length] = '/';`
`755`	`755`	`st.resource.Span.CopyTo(buf.Slice(st.baseUri.Length + 1));`
`756`	`756`	`});`
Original file line number	Diff line number	Diff line change
`@@ -576,11 +576,11 @@ public static string ConvertOldStringsToClass(string set, string category)`
`576`	`576`	`span[FlagsIndex] = '\0';`
`577`	`577`	`span[SetLengthIndex] = (char)state.set.Length;`
`578`	`578`	`span[CategoryLengthIndex] = (char)state.category.Length;`
`579`		`- state.set.AsSpan().CopyTo(span.Slice(SetStartIndex));`
	`579`	`+ state.set.CopyTo(span.Slice(SetStartIndex));`
`580`	`580`	`index = SetStartIndex + state.set.Length;`
`581`	`581`	`}`
`582`	`582`
`583`		`- state.category.AsSpan().CopyTo(span.Slice(index));`
	`583`	`+ state.category.CopyTo(span.Slice(index));`
`584`	`584`	`});`
`585`	`585`	`}`
`586`	`586`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ internal static string ValidateString(string input)`
`34`	`34`	`// slow case: surrogates exist, so we need to validate them`
`35`	`35`	`return string.Create(input.Length, (input, idxOfFirstSurrogate), (chars, state) =>`
`36`	`36`	`{`
`37`		`- state.input.AsSpan().CopyTo(chars);`
	`37`	`+ state.input.CopyTo(chars);`
`38`	`38`	`for (int i = state.idxOfFirstSurrogate; i < chars.Length; i++)`
`39`	`39`	`{`
`40`	`40`	`char thisChar = chars[i];`