Skip to content

Clarify return values of Base64Url.Try* methods #10561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2024
Merged

Clarify return values of Base64Url.Try* methods #10561

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions xml/System.Buffers.Text/Base64Url.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -705,7 +705,7 @@
<param name="bytesWritten">When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
<summary>Decodes the span of unicode ASCII chars represented as Base64Url into binary data.</summary>
<returns>
<see langword="true" /> if bytes decoded successfully, otherwise <see langword="false" />.</returns>
<see langword="true" /> if bytes decoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.FormatException">
<para>
Expand Down Expand Up @@ -740,7 +740,7 @@
<param name="bytesWritten">When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
<summary>Decodes the span of UTF-8 encoded text represented as Base64Url into binary data.</summary>
<returns>
<see langword="true" /> if bytes decoded successfully, otherwise <see langword="false" />.</returns>
<see langword="true" /> if bytes decoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.FormatException">
<para>
Expand Down Expand Up @@ -775,7 +775,7 @@
<param name="charsWritten">When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
<summary>Encodes the span of binary data into unicode ASCII chars represented as Base64Url.</summary>
<returns>
<see langword="true" /> if chars encoded successfully, otherwise <see langword="false" />.</returns>
<see langword="true" /> if chars encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
<remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -805,7 +805,7 @@
<param name="bytesWritten">When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
<summary>Encodes the span of binary data into UTF-8 encoded chars represented as Base64Url.</summary>
<returns>
<see langword="true" /> if bytes encoded successfully, otherwise <see langword="false" />.</returns>
<see langword="true" /> if bytes encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
<remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -844,7 +844,7 @@
<para>The encoded text output is larger than the binary data contained in the input (the operation inflates the data).</para>
</summary>
<returns>
<see langword="true" /> if bytes encoded successfully, otherwise <see langword="false" />.</returns>
<see langword="true" /> if bytes encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
<remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks>
</Docs>
</Member>
Expand Down