<param name="destination" />
<param name="bytesWritten" />
</member>
- <member name="T:System.IO.Compression.BrotliEncoder" />
+ <member name="T:System.IO.Compression.BrotliEncoder">
+ <summary>Provides methods and static methods to encode and decode data in a streamless, non-allocating, and performant manner using the Brotli data format specification.</summary>
+ </member>
<member name="M:System.IO.Compression.BrotliEncoder.#ctor(System.Int32,System.Int32)">
- <param name="quality" />
- <param name="window" />
+ <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.BrotliEncoder" /> structure using the specified quality and window.</summary>
+ <param name="quality">A number representing quality of the Brotli compression. 0 is the minimum (no compression), 11 is the maximum.</param>
+ <param name="window">A number representing the encoder window bits. The minimum value is 10, and the maximum value is 24.</param>
+ <exception cref="T:System.ArgumentOutOfRangeException">
+ <paramref name="quality" /> is not between the minimum value of 0 and the maximum value of 11.
+-or-
+<paramref name="window" /> is not between the minimum value of 10 and the maximum value of 24.</exception>
+ <exception cref="T:System.IO.IOException">Failed to create the <see cref="T:System.IO.Compression.BrotliEncoder" /> instance.</exception>
</member>
<member name="M:System.IO.Compression.BrotliEncoder.Compress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32@,System.Boolean)">
- <param name="source" />
- <param name="destination" />
- <param name="bytesConsumed" />
- <param name="bytesWritten" />
- <param name="isFinalBlock" />
+ <summary>Compresses a read-only byte span into a destination span.</summary>
+ <param name="source">A read-only span of bytes containing the source data to compress.</param>
+ <param name="destination">When this method returns, a byte span where the compressed is stored.</param>
+ <param name="bytesConsumed">When this method returns, the total number of bytes that were read from <paramref name="source" />.</param>
+ <param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
+ <param name="isFinalBlock">
+ <see langword="true" /> to finalize the internal stream, which prevents adding more input data when this method returns; <see langword="false" /> to allow the encoder to postpone the production of output until it has processed enough input.</param>
+ <returns>One of the enumeration values that describes the status with which the span-based operation finished.</returns>
+ </member>
+ <member name="M:System.IO.Compression.BrotliEncoder.Dispose">
+ <summary>Frees and disposes unmanaged resources.</summary>
</member>
- <member name="M:System.IO.Compression.BrotliEncoder.Dispose" />
<member name="M:System.IO.Compression.BrotliEncoder.Flush(System.Span{System.Byte},System.Int32@)">
- <param name="destination" />
- <param name="bytesWritten" />
+ <summary>Compresses an empty read-only span of bytes into its destination, which ensures that output is produced for all the processed input. An actual flush is performed when the source is depleted and there is enough space in the destination for the remaining data.</summary>
+ <param name="destination">When this method returns, a span of bytes where the compressed data will be stored.</param>
+ <param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
+ <returns>One of the enumeration values that describes the status with which the operation finished.</returns>
</member>
<member name="M:System.IO.Compression.BrotliEncoder.GetMaxCompressedLength(System.Int32)">
- <param name="inputSize" />
+ <summary>Gets the maximum expected compressed length for the provided input size.</summary>
+ <param name="inputSize">The input size to get the maximum expected compressed length from. Must be greater or equal than 0 and less or equal than <see cref="F:System.Int32.MaxValue" /> - 515.</param>
+ <returns>A number representing the maximum compressed length for the provided input size.</returns>
+ <exception cref="T:System.ArgumentOutOfRangeException">
+ <paramref name="inputSize" /> is less than 0, the minimum allowed input size, or greater than <see cref="F:System.Int32.MaxValue" /> - 515, the maximum allowed input size.</exception>
</member>
<member name="M:System.IO.Compression.BrotliEncoder.TryCompress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@)">
- <param name="source" />
- <param name="destination" />
- <param name="bytesWritten" />
+ <summary>Tries to compress a source byte span into a destination span.</summary>
+ <param name="source">A read-only span of bytes containing the source data to compress.</param>
+ <param name="destination">When this method returns, a span of bytes where the compressed data is stored.</param>
+ <param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
+ <returns>
+ <see langword="true" /> if the compression operation was successful; <see langword="false" /> otherwise.</returns>
</member>
<member name="M:System.IO.Compression.BrotliEncoder.TryCompress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32,System.Int32)">
- <param name="source" />
- <param name="destination" />
- <param name="bytesWritten" />
- <param name="quality" />
- <param name="window" />
+ <summary>Tries to compress a source byte span into a destination byte span, using the provided compression quality leven and encoder window bits.</summary>
+ <param name="source">A read-only span of bytes containing the source data to compress.</param>
+ <param name="destination">When this method returns, a span of bytes where the compressed data is stored.</param>
+ <param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
+ <param name="quality">A number representing quality of the Brotli compression. 0 is the minimum (no compression), 11 is the maximum.</param>
+ <param name="window">A number representing the encoder window bits. The minimum value is 10, and the maximum value is 24.</param>
+ <returns>
+ <see langword="true" /> if the compression operation was successful; <see langword="false" /> otherwise.</returns>
</member>
<member name="T:System.IO.Compression.BrotliStream">
<summary>Provides methods and properties used to compress and decompress streams by using the Brotli data format specification.</summary>
<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression mode, and optionally leaves the stream open.</summary>
<param name="stream">The stream to compress.</param>
<param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
- <param name="leaveOpen" />
+ <param name="leaveOpen">
+ <see langword="true" /> to leave the stream open after the <see cref="T:System.IO.Compression.BrotliStream" /> object is disposed; otherwise, <see langword="false" />.</param>
</member>
<member name="P:System.IO.Compression.BrotliStream.BaseStream">
<summary>Gets a reference to the underlying stream.</summary>
projects / platform / core / csapi / tizenfx.git / blobdiff