Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -246,10 +246,12 @@ public bool TryDecompress(Stream compressedData, Stream destination)
/// Tries to decompress the data from the stream and write the result to the destination, asynchronously.
/// </summary>
/// <remarks>
/// Genuinely asynchronous: no thread is held for the duration.
/// If this throws or returns false, the destination may hold a partial result. Cancellation still
/// flushes the trailer, so a truncated destination cannot be distinguished from a complete
/// decompression. Treat the destination as invalid unless the method returns true.
/// Genuinely asynchronous: no thread is held for the duration. The decompression stream wraps the
/// source rather than the destination, so disposing it writes nothing to the destination.
/// If this throws or returns false, the destination may hold a partial result. Decompressed bytes
/// carry no structure of their own, so a truncated destination cannot be distinguished from a
/// complete decompression by inspecting it. Treat the destination as invalid unless the method
/// returns true.
/// </remarks>
/// <param name="compressedData">The compressed data to decompress.</param>
/// <param name="destination">The destination to write the decompressed data to.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,10 +246,12 @@ public bool TryDecompress(Stream compressedData, Stream destination)
/// Tries to decompress the data from the stream and write the result to the destination, asynchronously.
/// </summary>
/// <remarks>
/// Genuinely asynchronous: no thread is held for the duration.
/// If this throws or returns false, the destination may hold a partial result. Cancellation still
/// flushes the trailer, so a truncated destination cannot be distinguished from a complete
/// decompression. Treat the destination as invalid unless the method returns true.
/// Genuinely asynchronous: no thread is held for the duration. The decompression stream wraps the
/// source rather than the destination, so disposing it writes nothing to the destination.
/// If this throws or returns false, the destination may hold a partial result. Decompressed bytes
/// carry no structure of their own, so a truncated destination cannot be distinguished from a
/// complete decompression by inspecting it. Treat the destination as invalid unless the method
/// returns true.
/// </remarks>
/// <param name="compressedData">The compressed data to decompress.</param>
/// <param name="destination">The destination to write the decompressed data to.</param>
Expand Down
10 changes: 6 additions & 4 deletions Essentials.CompressionProviders.Gzip/GzipCompressionProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -247,10 +247,12 @@ public bool TryDecompress(Stream compressedData, Stream destination)
/// Tries to decompress the data from the stream and write the result to the destination, asynchronously.
/// </summary>
/// <remarks>
/// Genuinely asynchronous: no thread is held for the duration.
/// If this throws or returns false, the destination may hold a partial result. Cancellation still
/// flushes the trailer, so a truncated destination cannot be distinguished from a complete
/// decompression. Treat the destination as invalid unless the method returns true.
/// Genuinely asynchronous: no thread is held for the duration. The decompression stream wraps the
/// source rather than the destination, so disposing it writes nothing to the destination.
/// If this throws or returns false, the destination may hold a partial result. Decompressed bytes
/// carry no structure of their own, so a truncated destination cannot be distinguished from a
/// complete decompression by inspecting it. Treat the destination as invalid unless the method
/// returns true.
/// </remarks>
/// <param name="compressedData">The compressed data to decompress.</param>
/// <param name="destination">The destination to write the decompressed data to.</param>
Expand Down
10 changes: 6 additions & 4 deletions Essentials.CompressionProviders.ZLib/ZLibCompressionProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -246,10 +246,12 @@ public bool TryDecompress(Stream compressedData, Stream destination)
/// Tries to decompress the data from the stream and write the result to the destination, asynchronously.
/// </summary>
/// <remarks>
/// Genuinely asynchronous: no thread is held for the duration.
/// If this throws or returns false, the destination may hold a partial result. Cancellation still
/// flushes the trailer, so a truncated destination cannot be distinguished from a complete
/// decompression. Treat the destination as invalid unless the method returns true.
/// Genuinely asynchronous: no thread is held for the duration. The decompression stream wraps the
/// source rather than the destination, so disposing it writes nothing to the destination.
/// If this throws or returns false, the destination may hold a partial result. Decompressed bytes
/// carry no structure of their own, so a truncated destination cannot be distinguished from a
/// complete decompression by inspecting it. Treat the destination as invalid unless the method
/// returns true.
/// </remarks>
/// <param name="compressedData">The compressed data to decompress.</param>
/// <param name="destination">The destination to write the decompressed data to.</param>
Expand Down
10 changes: 6 additions & 4 deletions Essentials.EncryptionProviders.Aes/AesEncryptionProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -290,10 +290,12 @@ public bool TryDecrypt(Stream data, ReadOnlySpan<byte> key, ReadOnlySpan<byte> i
/// Tries to decrypt the data from the stream and write the result to the destination, asynchronously.
/// </summary>
/// <remarks>
/// Genuinely asynchronous: no thread is held for the duration.
/// If this throws or returns false, the destination may hold a partial result. Cancellation still
/// flushes the final block, so a truncated destination cannot be distinguished from a complete
/// decryption. Treat the destination as invalid unless the method returns true.
/// Genuinely asynchronous: no thread is held for the duration. The decrypting stream wraps the
/// source rather than the destination, so disposing it writes nothing to the destination.
/// If this throws or returns false, the destination may hold a partial result. Recovered plaintext
/// carries no structure of its own, so a truncated destination cannot be distinguished from a
/// complete decryption by inspecting it. Treat the destination as invalid unless the method
/// returns true.
/// </remarks>
/// <param name="data">The data to decrypt.</param>
/// <param name="key">The key to use for decryption.</param>
Expand Down