|
39 | 39 | <Docs>
|
40 | 40 | <summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Shake128" /> class.</summary>
|
41 | 41 | <remarks>To be added.</remarks>
|
42 |
| - <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
| 42 | + <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
43 | 43 | to determine if the platform supports SHAKE128.</exception>
|
44 | 44 | </Docs>
|
45 | 45 | </Member>
|
|
126 | 126 | </ReturnValue>
|
127 | 127 | <Parameters />
|
128 | 128 | <Docs>
|
129 |
| - <summary>To be added.</summary> |
130 |
| - <returns>To be added.</returns> |
| 129 | + <summary>Creates a new instance of <see cref="T:System.Security.Cryptography.Shake128" /> with the existing appended data preserved.</summary> |
| 130 | + <returns>A clone of the current instance.</returns> |
131 | 131 | <remarks>To be added.</remarks>
|
| 132 | + <exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception> |
| 133 | + <exception cref="T:System.InvalidOperationException">The current instance is being read from and cannot be cloned.</exception> |
| 134 | + <exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception> |
132 | 135 | </Docs>
|
133 | 136 | </Member>
|
134 | 137 | <Member MemberName="Dispose">
|
|
314 | 317 | <paramref name="outputLength" /> is negative.</exception>
|
315 | 318 | <exception cref="T:System.ArgumentNullException">
|
316 | 319 | <paramref name="source" /> is <see langword="null" />.</exception>
|
317 |
| - <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
| 320 | + <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
318 | 321 | to determine if the platform supports SHAKE128.</exception>
|
319 | 322 | </Docs>
|
320 | 323 | </Member>
|
|
356 | 359 | <paramref name="outputLength" /> is negative.</exception>
|
357 | 360 | <exception cref="T:System.ArgumentNullException">
|
358 | 361 | <paramref name="source" /> is <see langword="null" />.</exception>
|
359 |
| - <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
| 362 | + <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
360 | 363 | to determine if the platform supports SHAKE128.</exception>
|
361 | 364 | </Docs>
|
362 | 365 | </Member>
|
|
396 | 399 | <paramref name="source" /> does not support reading.</exception>
|
397 | 400 | <exception cref="T:System.ArgumentNullException">
|
398 | 401 | <paramref name="source" /> is <see langword="null" />.</exception>
|
399 |
| - <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
| 402 | + <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
400 | 403 | to determine if the platform supports SHAKE128.</exception>
|
401 | 404 | </Docs>
|
402 | 405 | </Member>
|
|
434 | 437 | <remarks>To be added.</remarks>
|
435 | 438 | <exception cref="T:System.ArgumentOutOfRangeException">
|
436 | 439 | <paramref name="outputLength" /> is negative.</exception>
|
437 |
| - <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
| 440 | + <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
438 | 441 | to determine if the platform supports SHAKE128.</exception>
|
439 | 442 | </Docs>
|
440 | 443 | </Member>
|
|
463 | 466 | <param name="destination">The buffer to fill with the hash.</param>
|
464 | 467 | <summary>Computes the hash of data using the SHAKE128 algorithm.</summary>
|
465 | 468 | <remarks>To be added.</remarks>
|
466 |
| - <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
| 469 | + <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
467 | 470 | to determine if the platform supports SHAKE128.</exception>
|
468 | 471 | </Docs>
|
469 | 472 | </Member>
|
|
502 | 505 | <Docs>
|
503 | 506 | <param name="source">The stream to hash.</param>
|
504 | 507 | <param name="outputLength">The size of the hash to produce.</param>
|
505 |
| - <param name="cancellationToken">The token to monitor for cancellation requests. |
| 508 | + <param name="cancellationToken">The token to monitor for cancellation requests. |
506 | 509 | The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
507 | 510 | <summary>Asynchronously computes the hash of a stream using the SHAKE128 algorithm.</summary>
|
508 | 511 | <returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> that completes with the computed hash.</returns>
|
|
515 | 518 | <paramref name="source" /> is <see langword="null" />.</exception>
|
516 | 519 | <exception cref="T:System.OperationCanceledException">
|
517 | 520 | <paramref name="cancellationToken" /> has been canceled.</exception>
|
518 |
| - <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
| 521 | + <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
519 | 522 | to determine if the platform supports SHAKE128.</exception>
|
520 | 523 | </Docs>
|
521 | 524 | </Member>
|
|
549 | 552 | <Docs>
|
550 | 553 | <param name="source">The stream to hash.</param>
|
551 | 554 | <param name="destination">The buffer to fill with the hash.</param>
|
552 |
| - <param name="cancellationToken">The token to monitor for cancellation requests. |
| 555 | + <param name="cancellationToken">The token to monitor for cancellation requests. |
553 | 556 | The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
554 | 557 | <summary>Asynchronously computes the hash of a stream using the SHAKE128 algorithm.</summary>
|
555 | 558 | <returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> that represents the asynchronous operation.</returns>
|
|
560 | 563 | <paramref name="source" /> does not support reading.</exception>
|
561 | 564 | <exception cref="T:System.OperationCanceledException">
|
562 | 565 | <paramref name="cancellationToken" /> has been canceled.</exception>
|
563 |
| - <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
| 566 | + <exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property |
564 | 567 | to determine if the platform supports SHAKE128.</exception>
|
565 | 568 | </Docs>
|
566 | 569 | </Member>
|
|
612 | 615 | <Parameter Name="outputLength" Type="System.Int32" Index="0" FrameworkAlternate="net-9.0" />
|
613 | 616 | </Parameters>
|
614 | 617 | <Docs>
|
615 |
| - <param name="outputLength">To be added.</param> |
616 |
| - <summary>To be added.</summary> |
617 |
| - <returns>To be added.</returns> |
| 618 | + <param name="outputLength">The size of the hash to produce.</param> |
| 619 | + <summary>Retrieves the hash for the data accumulated from prior calls to the <c>AppendData</c> methods without resetting the object to its initial state and allowing additional calls to continue retrieving the hash.</summary> |
| 620 | + <returns>The computed hash.</returns> |
618 | 621 | <remarks>To be added.</remarks>
|
| 622 | + <exception cref="T:System.ArgumentOutOfRangeException"> |
| 623 | + <paramref name="outputLength" /> is negative.</exception> |
| 624 | + <exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception> |
| 625 | + <exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception> |
| 626 | + <exception cref="T:System.PlatformNotSupportedException">The platform does not support multiple reads of the hash. <see cref="M:System.Security.Cryptography.Shake128.GetHashAndReset(System.Int32)" /> can be used |
| 627 | + to perform a single operation.</exception> |
619 | 628 | </Docs>
|
620 | 629 | </Member>
|
621 | 630 | <Member MemberName="Read">
|
|
637 | 646 | <Parameter Name="destination" Type="System.Span<System.Byte>" Index="0" FrameworkAlternate="net-9.0" />
|
638 | 647 | </Parameters>
|
639 | 648 | <Docs>
|
640 |
| - <param name="destination">To be added.</param> |
641 |
| - <summary>To be added.</summary> |
| 649 | + <param name="destination">The buffer to fill with the hash.</param> |
| 650 | + <summary>Fills the buffer with the hash for the data accumulated from prior calls to the <c>AppendData</c> methods without resetting the object to its initial state and allowing additional calls to continue retrieving the hash.</summary> |
642 | 651 | <remarks>To be added.</remarks>
|
| 652 | + <exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception> |
| 653 | + <exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception> |
| 654 | + <exception cref="T:System.PlatformNotSupportedException">The platform does not support multiple reads of the hash. <see cref="M:System.Security.Cryptography.Shake128.GetHashAndReset(System.Span{System.Byte})" /> can be used |
| 655 | + to perform a single operation.</exception> |
643 | 656 | </Docs>
|
644 | 657 | </Member>
|
645 | 658 | <Member MemberName="Reset">
|
|
659 | 672 | </ReturnValue>
|
660 | 673 | <Parameters />
|
661 | 674 | <Docs>
|
662 |
| - <summary>To be added.</summary> |
| 675 | + <summary>Resets the instance back to its initial state.</summary> |
663 | 676 | <remarks>To be added.</remarks>
|
| 677 | + <exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception> |
| 678 | + <exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception> |
664 | 679 | </Docs>
|
665 | 680 | </Member>
|
666 | 681 | </Members>
|
|
0 commit comments