|
27 | 27 | <Interfaces /> |
28 | 28 | <Docs> |
29 | 29 | <summary>Converts between binary data and URL-safe ASCII encoded text that's represented in Base64Url characters.</summary> |
30 | | - <remarks>To be added.</remarks> |
| 30 | + <remarks>Base64Url encoding uses the same alphabet as standard Base64 encoding, except that the characters '+' and '/' are replaced with '-' and '_' respectively to make the output URL-safe.</remarks> |
31 | 31 | </Docs> |
32 | 32 | <Members> |
33 | 33 | <Member MemberName="DecodeFromChars"> |
|
373 | 373 | <param name="source">The input span which contains binary data that needs to be encoded.</param> |
374 | 374 | <summary>Encodes the span of binary data into unicode ASCII chars represented as Base64Url.</summary> |
375 | 375 | <returns>A char array which contains the result of the operation, i.e. the ASCII chars in Base64Url.</returns> |
376 | | - <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks> |
| 376 | + <remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks> |
377 | 377 | </Docs> |
378 | 378 | </Member> |
379 | 379 | <Member MemberName="EncodeToChars"> |
|
406 | 406 | <param name="destination">The output span which contains the result of the operation, i.e. the ASCII chars in Base64Url.</param> |
407 | 407 | <summary>Encodes the span of binary data into Unicode ASCII chars represented as Base64Url.</summary> |
408 | 408 | <returns>The number of bytes written into the destination span. This can be used to slice the output for subsequent calls, if necessary.</returns> |
409 | | - <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks> |
| 409 | + <remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks> |
410 | 410 | <exception cref="T:System.ArgumentException">The buffer in <paramref name="destination" /> is too small to hold the encoded output.</exception> |
411 | 411 | </Docs> |
412 | 412 | </Member> |
|
449 | 449 | </param> |
450 | 450 | <summary>Encodes the span of binary data into unicode ASCII chars represented as Base64Url.</summary> |
451 | 451 | <returns>One of the enumeration values that indicates the success or failure of the operation.</returns> |
452 | | - <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks> |
| 452 | + <remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks> |
453 | 453 | </Docs> |
454 | 454 | </Member> |
455 | 455 | <Member MemberName="EncodeToString"> |
|
486 | 486 | <param name="source">The input span that contains binary data that needs to be encoded.</param> |
487 | 487 | <summary>Encodes the span of binary data into Unicode string represented as Base64Url ASCII chars.</summary> |
488 | 488 | <returns>A string that contains the result of the operation, i.e. the ASCII string in Base64Url.</returns> |
489 | | - <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks> |
| 489 | + <remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks> |
490 | 490 | </Docs> |
491 | 491 | </Member> |
492 | 492 | <Member MemberName="EncodeToUtf8"> |
|
523 | 523 | <param name="source">The input span which contains binary data that needs to be encoded.</param> |
524 | 524 | <summary>Encodes the span of binary data into UTF-8 encoded text represented as Base64Url.</summary> |
525 | 525 | <returns>The output byte array which contains the result of the operation, i.e. the UTF-8 encoded text in Base64Url.</returns> |
526 | | - <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks> |
| 526 | + <remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks> |
527 | 527 | </Docs> |
528 | 528 | </Member> |
529 | 529 | <Member MemberName="EncodeToUtf8"> |
|
556 | 556 | <param name="destination">The output span which contains the result of the operation, i.e. the UTF-8 encoded text in Base64Url.</param> |
557 | 557 | <summary>Encodes the span of binary data into UTF-8 encoded text represented as Base64Url.</summary> |
558 | 558 | <returns>The number of bytes written into the destination span. This can be used to slice the output for subsequent calls, if necessary.</returns> |
559 | | - <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks> |
| 559 | + <remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks> |
560 | 560 | <exception cref="T:System.ArgumentException">The buffer in <paramref name="destination" /> is too small to hold the encoded output.</exception> |
561 | 561 | </Docs> |
562 | 562 | </Member> |
|
599 | 599 | </param> |
600 | 600 | <summary>Encodes the span of binary data into UTF-8 encoded text represented as Base64Url.</summary> |
601 | 601 | <returns>One of the enumeration values that indicates the success or failure of the operation.</returns> |
602 | | - <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks> |
| 602 | + <remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks> |
603 | 603 | </Docs> |
604 | 604 | </Member> |
605 | 605 | <Member MemberName="GetEncodedLength"> |
|
926 | 926 | <summary>Encodes the span of binary data into Unicode ASCII chars represented as Base64Url.</summary> |
927 | 927 | <returns> |
928 | 928 | <see langword="true" /> if chars encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns> |
929 | | - <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks> |
| 929 | + <remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks> |
930 | 930 | </Docs> |
931 | 931 | </Member> |
932 | 932 | <Member MemberName="TryEncodeToUtf8"> |
|
962 | 962 | <summary>Encodes the span of binary data into UTF-8 encoded chars represented as Base64Url.</summary> |
963 | 963 | <returns> |
964 | 964 | <see langword="true" /> if bytes encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns> |
965 | | - <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks> |
| 965 | + <remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks> |
966 | 966 | </Docs> |
967 | 967 | </Member> |
968 | 968 | <Member MemberName="TryEncodeToUtf8InPlace"> |
|
1007 | 1007 | </summary> |
1008 | 1008 | <returns> |
1009 | 1009 | <see langword="true" /> if bytes encoded successfully; <see langword="false" /> if <paramref name="buffer" /> is too small to fit the result.</returns> |
1010 | | - <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks> |
| 1010 | + <remarks>This implementation of the Base64Url encoding omits the optional padding characters. The encoding uses '-' and '_' instead of the '+' and '/' characters used in standard Base64 encoding.</remarks> |
1011 | 1011 | </Docs> |
1012 | 1012 | </Member> |
1013 | 1013 | </Members> |
|
0 commit comments