pkg/Tizen.NET.API11/build/tizen11.0/ref/System.IO.Compression.Brotli.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <doc>
   3   <assembly>
   4     <name>System.IO.Compression.Brotli</name>
   5   </assembly>
   6   <members>
   7     <member name="T:System.IO.Compression.BrotliDecoder" />
   8     <member name="M:System.IO.Compression.BrotliDecoder.Decompress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32@)">
   9       <param name="source" />
  10       <param name="destination" />
  11       <param name="bytesConsumed" />
  12       <param name="bytesWritten" />
  13     </member>
  14     <member name="M:System.IO.Compression.BrotliDecoder.Dispose" />
  15     <member name="M:System.IO.Compression.BrotliDecoder.TryDecompress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@)">
  16       <param name="source" />
  17       <param name="destination" />
  18       <param name="bytesWritten" />
  19     </member>
  20     <member name="T:System.IO.Compression.BrotliEncoder">
  21       <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>
  22     </member>
  23     <member name="M:System.IO.Compression.BrotliEncoder.#ctor(System.Int32,System.Int32)">
  24       <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.BrotliEncoder" /> structure using the specified quality and window.</summary>
  25       <param name="quality">A number representing quality of the Brotli compression. 0 is the minimum (no compression), 11 is the maximum.</param>
  26       <param name="window">A number representing the encoder window bits. The minimum value is 10, and the maximum value is 24.</param>
  27       <exception cref="T:System.ArgumentOutOfRangeException">
  28         <paramref name="quality" /> is not between the minimum value of 0 and the maximum value of 11.
  29 -or-
  30 <paramref name="window" /> is not between the minimum value of 10 and the maximum value of 24.</exception>
  31       <exception cref="T:System.IO.IOException">Failed to create the <see cref="T:System.IO.Compression.BrotliEncoder" /> instance.</exception>
  32     </member>
  33     <member name="M:System.IO.Compression.BrotliEncoder.Compress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32@,System.Boolean)">
  34       <summary>Compresses a read-only byte span into a destination span.</summary>
  35       <param name="source">A read-only span of bytes containing the source data to compress.</param>
  36       <param name="destination">When this method returns, a byte span where the compressed is stored.</param>
  37       <param name="bytesConsumed">When this method returns, the total number of bytes that were read from <paramref name="source" />.</param>
  38       <param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
  39       <param name="isFinalBlock">
  40         <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>
  41       <returns>One of the enumeration values that describes the status with which the span-based operation finished.</returns>
  42     </member>
  43     <member name="M:System.IO.Compression.BrotliEncoder.Dispose">
  44       <summary>Frees and disposes unmanaged resources.</summary>
  45     </member>
  46     <member name="M:System.IO.Compression.BrotliEncoder.Flush(System.Span{System.Byte},System.Int32@)">
  47       <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>
  48       <param name="destination">When this method returns, a span of bytes where the compressed data will be stored.</param>
  49       <param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
  50       <returns>One of the enumeration values that describes the status with which the operation finished.</returns>
  51     </member>
  52     <member name="M:System.IO.Compression.BrotliEncoder.GetMaxCompressedLength(System.Int32)">
  53       <summary>Gets the maximum expected compressed length for the provided input size.</summary>
  54       <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>
  55       <returns>A number representing the maximum compressed length for the provided input size.</returns>
  56       <exception cref="T:System.ArgumentOutOfRangeException">
  57         <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>
  58     </member>
  59     <member name="M:System.IO.Compression.BrotliEncoder.TryCompress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@)">
  60       <summary>Tries to compress a source byte span into a destination span.</summary>
  61       <param name="source">A read-only span of bytes containing the source data to compress.</param>
  62       <param name="destination">When this method returns, a span of bytes where the compressed data is stored.</param>
  63       <param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
  64       <returns>
  65         <see langword="true" /> if the compression operation was successful; <see langword="false" /> otherwise.</returns>
  66     </member>
  67     <member name="M:System.IO.Compression.BrotliEncoder.TryCompress(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32,System.Int32)">
  68       <summary>Tries to compress a source byte span into a destination byte span, using the provided compression quality leven and encoder window bits.</summary>
  69       <param name="source">A read-only span of bytes containing the source data to compress.</param>
  70       <param name="destination">When this method returns, a span of bytes where the compressed data is stored.</param>
  71       <param name="bytesWritten">When this method returns, the total number of bytes that were written to <paramref name="destination" />.</param>
  72       <param name="quality">A number representing quality of the Brotli compression. 0 is the minimum (no compression), 11 is the maximum.</param>
  73       <param name="window">A number representing the encoder window bits. The minimum value is 10, and the maximum value is 24.</param>
  74       <returns>
  75         <see langword="true" /> if the compression operation was successful; <see langword="false" /> otherwise.</returns>
  76     </member>
  77     <member name="T:System.IO.Compression.BrotliStream">
  78       <summary>Provides methods and properties used to compress and decompress streams by using the Brotli data format specification.</summary>
  79     </member>
  80     <member name="M:System.IO.Compression.BrotliStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel)">
  81       <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression level.</summary>
  82       <param name="stream">The stream to compress.</param>
  83       <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
  84     </member>
  85     <member name="M:System.IO.Compression.BrotliStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionLevel,System.Boolean)">
  86       <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression level, and optionally leaves the stream open.</summary>
  87       <param name="stream">The stream to compress.</param>
  88       <param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.</param>
  89       <param name="leaveOpen">
  90         <see langword="true" /> to leave the stream open after disposing the <see cref="T:System.IO.Compression.BrotliStream" /> object; otherwise, <see langword="false" />.</param>
  91     </member>
  92     <member name="M:System.IO.Compression.BrotliStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode)">
  93       <summary>Initializes a new instance of the <see cref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression mode.</summary>
  94       <param name="stream">The stream to compress.</param>
  95       <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
  96     </member>
  97     <member name="M:System.IO.Compression.BrotliStream.#ctor(System.IO.Stream,System.IO.Compression.CompressionMode,System.Boolean)">
  98       <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>
  99       <param name="stream">The stream to compress.</param>
 100       <param name="mode">One of the enumeration values that indicates whether to compress or decompress the stream.</param>
 101       <param name="leaveOpen">
 102         <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>
 103     </member>
 104     <member name="P:System.IO.Compression.BrotliStream.BaseStream">
 105       <summary>Gets a reference to the underlying stream.</summary>
 106       <returns>A stream object that represents the underlying stream.</returns>
 107       <exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
 108     </member>
 109     <member name="M:System.IO.Compression.BrotliStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
 110       <summary>Begins an asynchronous read operation. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
 111       <param name="buffer">The buffer from which data will be read.</param>
 112       <param name="offset">The byte offset in <paramref name="array" /> at which to begin reading data from the stream.</param>
 113       <param name="count">To maximum number of bytes to read.</param>
 114       <param name="asyncCallback">An optional asynchronous callback, to be called when the read operation is complete.</param>
 115       <param name="asyncState">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
 116       <returns>An object that represents the asynchronous read operation, which could still be pending.</returns>
 117       <exception cref="T:System.IO.IOException">The method tried to read asynchronously past the end of the stream, or a disk error occurred.</exception>
 118       <exception cref="T:System.ArgumentException">One or more of the arguments is invalid.</exception>
 119       <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
 120       <exception cref="T:System.NotSupportedException">The current <see cref="T:System.IO.Compression.BrotliStream" /> implementation does not support the read operation.</exception>
 121       <exception cref="T:System.InvalidOperationException">This call cannot be completed.</exception>
 122     </member>
 123     <member name="M:System.IO.Compression.BrotliStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
 124       <summary>Begins an asynchronous write operation. (Consider using the <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
 125       <param name="buffer">The buffer from which data will be written.</param>
 126       <param name="offset">The byte offset in <paramref name="array" /> at which to begin writing data from the stream.</param>
 127       <param name="count">The maximum number of bytes to write.</param>
 128       <param name="asyncCallback">An optional asynchronous callback, to be called when the write operation is complete.</param>
 129       <param name="asyncState">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
 130       <returns>An object that represents the asynchronous write operation, which could still be pending.</returns>
 131       <exception cref="T:System.IO.IOException">The method tried to write asynchronously past the end of the stream, or a disk error occurred.</exception>
 132       <exception cref="T:System.ArgumentException">One or more of the arguments is invalid.</exception>
 133       <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
 134       <exception cref="T:System.NotSupportedException">The current <see cref="T:System.IO.Compression.BrotliStream" /> implementation does not support the write operation.</exception>
 135       <exception cref="T:System.InvalidOperationException">The write operation cannot be performed because the stream is closed.</exception>
 136     </member>
 137     <member name="P:System.IO.Compression.BrotliStream.CanRead">
 138       <summary>Gets a value indicating whether the stream supports reading while decompressing a file.</summary>
 139       <returns>
 140         <see langword="true" /> if the <see cref="T:System.IO.Compression.CompressionMode" /> value is <see langword="Decompress," /> and the underlying stream supports reading and is not closed; otherwise, <see langword="false" />.</returns>
 141     </member>
 142     <member name="P:System.IO.Compression.BrotliStream.CanSeek">
 143       <summary>Gets a value indicating whether the stream supports seeking.</summary>
 144       <returns>
 145         <see langword="false" /> in all cases.</returns>
 146     </member>
 147     <member name="P:System.IO.Compression.BrotliStream.CanWrite">
 148       <summary>Gets a value indicating whether the stream supports writing.</summary>
 149       <returns>
 150         <see langword="true" /> if the <see cref="T:System.IO.Compression.CompressionMode" /> value is <see langword="Compress" />, and the underlying stream supports writing and is not closed; otherwise, <see langword="false" />.</returns>
 151     </member>
 152     <member name="M:System.IO.Compression.BrotliStream.DisposeAsync">
 153       <summary>Asynchronously releases the unmanaged resources used by the <see cref="T:System.IO.Compression.BrotliStream" />.</summary>
 154       <returns>A task that represents the asynchronous dispose operation.</returns>
 155     </member>
 156     <member name="M:System.IO.Compression.BrotliStream.EndRead(System.IAsyncResult)">
 157       <summary>Waits for the pending asynchronous read to complete. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
 158       <param name="asyncResult">The reference to the pending asynchronous request to finish.</param>
 159       <returns>The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. <see cref="T:System.IO.Compression.BrotliStream" /> returns 0 only at the end of the stream; otherwise, it blocks until at least one byte is available.</returns>
 160       <exception cref="T:System.ArgumentNullException">
 161         <paramref name="asyncResult" /> is <see langword="null" />.</exception>
 162       <exception cref="T:System.ArgumentException">
 163         <paramref name="asyncResult" /> did not originate from a <see cref="M:System.IO.Compression.BrotliStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /> method on the current stream.</exception>
 164       <exception cref="T:System.InvalidOperationException">The end operation cannot be performed because the stream is closed.</exception>
 165     </member>
 166     <member name="M:System.IO.Compression.BrotliStream.EndWrite(System.IAsyncResult)">
 167       <summary>Handles the end of an asynchronous write operation. (Consider using the <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
 168       <param name="asyncResult">The object that represents the asynchronous call.</param>
 169       <exception cref="T:System.InvalidOperationException">The underlying stream is closed or <see langword="null" />.</exception>
 170     </member>
 171     <member name="M:System.IO.Compression.BrotliStream.Flush">
 172       <summary>The current implementation of this method has no functionality.</summary>
 173     </member>
 174     <member name="M:System.IO.Compression.BrotliStream.FlushAsync(System.Threading.CancellationToken)">
 175       <summary>Asynchronously clears all buffers for this Brotli stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.</summary>
 176       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
 177       <returns>A task that represents the asynchronous flush operation.</returns>
 178     </member>
 179     <member name="P:System.IO.Compression.BrotliStream.Length">
 180       <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
 181       <returns>A long value.</returns>
 182       <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
 183     </member>
 184     <member name="P:System.IO.Compression.BrotliStream.Position">
 185       <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
 186       <returns>A long value.</returns>
 187       <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
 188     </member>
 189     <member name="M:System.IO.Compression.BrotliStream.Read(System.Byte[],System.Int32,System.Int32)">
 190       <summary>Reads a number of decompressed bytes into the specified byte array.</summary>
 191       <param name="buffer">The array used to store decompressed bytes.</param>
 192       <param name="offset">The byte offset in <paramref name="buffer" /> at which the read bytes will be placed.</param>
 193       <param name="count">The maximum number of decompressed bytes to read.</param>
 194       <returns>The number of bytes that were decompressed into the byte array. If the end of the stream has been reached, zero or the number of bytes read is returned.</returns>
 195       <exception cref="T:System.ArgumentNullException">
 196         <paramref name="buffer" /> is <see langword="null" />.</exception>
 197       <exception cref="T:System.InvalidOperationException">The <see cref="T:System.IO.Compression.CompressionMode" /> value was <see langword="Compress" /> when the object was created, or there is already an active asynchronous operation on this stream.</exception>
 198       <exception cref="T:System.ArgumentOutOfRangeException">
 199         <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
 200       <exception cref="T:System.ArgumentException">The <paramref name="buffer" /> length minus the index starting point is less than <paramref name="count" />.</exception>
 201       <exception cref="T:System.IO.InvalidDataException">The data is in an invalid format.</exception>
 202       <exception cref="T:System.ObjectDisposedException">The underlying stream is null or closed.</exception>
 203     </member>
 204     <member name="M:System.IO.Compression.BrotliStream.Read(System.Span{System.Byte})">
 205       <summary>Reads a sequence of bytes from the current Brotli stream to a byte span and advances the position within the Brotli stream by the number of bytes read.</summary>
 206       <param name="buffer">A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.</param>
 207       <returns>The total number of bytes read into the buffer. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
 208     </member>
 209     <member name="M:System.IO.Compression.BrotliStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
 210       <summary>Asynchronously reads a sequence of bytes from the current Brotli stream, writes them to a byte array starting at a specified index, advances the position within the Brotli stream by the number of bytes read, and monitors cancellation requests.</summary>
 211       <param name="buffer">The buffer to write the data into.</param>
 212       <param name="offset">The byte offset in <paramref name="buffer" /> at which to begin writing data from the Brotli stream.</param>
 213       <param name="count">The maximum number of bytes to read.</param>
 214       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
 215       <returns>A task that represents the asynchronous read operation, which wraps the total number of bytes read into the <paramref name="buffer" />. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the Brotli stream has been reached.</returns>
 216     </member>
 217     <member name="M:System.IO.Compression.BrotliStream.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
 218       <summary>Asynchronously reads a sequence of bytes from the current Brotli stream, writes them to a byte memory range, advances the position within the Brotli stream by the number of bytes read, and monitors cancellation requests.</summary>
 219       <param name="buffer">The region of memory to write the data into.</param>
 220       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
 221       <returns>A task that represents the asynchronous read operation, which wraps the total number of bytes read into the buffer. The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the Brotli stream has been reached.</returns>
 222     </member>
 223     <member name="M:System.IO.Compression.BrotliStream.Seek(System.Int64,System.IO.SeekOrigin)">
 224       <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
 225       <param name="offset">The location in the stream.</param>
 226       <param name="origin">One of the <see cref="T:System.IO.SeekOrigin" /> values.</param>
 227       <returns>A long value.</returns>
 228       <exception cref="T:System.NotSupportedException">This property is not supported on this stream.</exception>
 229     </member>
 230     <member name="M:System.IO.Compression.BrotliStream.SetLength(System.Int64)">
 231       <summary>This property is not supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
 232       <param name="value">The length of the stream.</param>
 233     </member>
 234     <member name="M:System.IO.Compression.BrotliStream.Write(System.Byte[],System.Int32,System.Int32)">
 235       <summary>Writes compressed bytes to the underlying stream from the specified byte array.</summary>
 236       <param name="buffer">The buffer containing the data to compress.</param>
 237       <param name="offset">The byte offset in <paramref name="array" /> from which the bytes will be read.</param>
 238       <param name="count">The maximum number of bytes to write.</param>
 239       <exception cref="T:System.ObjectDisposedException">The write operation cannot be performed because the stream is closed.</exception>
 240     </member>
 241     <member name="M:System.IO.Compression.BrotliStream.Write(System.ReadOnlySpan{System.Byte})">
 242       <summary>Writes a sequence of bytes to the current Brotli stream from a read-only byte span and advances the current position within this Brotli stream by the number of bytes written.</summary>
 243       <param name="buffer">A region of memory. This method copies the contents of this region to the current Brotli stream.</param>
 244     </member>
 245     <member name="M:System.IO.Compression.BrotliStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
 246       <summary>Asynchronously writes compressed bytes to the underlying Brotli stream from the specified byte array.</summary>
 247       <param name="buffer">The buffer that contains the data to compress.</param>
 248       <param name="offset">The zero-based byte offset in <paramref name="buffer" /> from which to begin copying bytes to the Brotli stream.</param>
 249       <param name="count">The maximum number of bytes to write.</param>
 250       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
 251       <returns>A task that represents the asynchronous write operation.</returns>
 252     </member>
 253     <member name="M:System.IO.Compression.BrotliStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
 254       <summary>Asynchronously writes compressed bytes to the underlying Brotli stream from the specified byte memory range.</summary>
 255       <param name="buffer">The memory region to write data from.</param>
 256       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
 257       <returns>A task that represents the asynchronous write operation.</returns>
 258     </member>
 259   </members>
 260 </doc>