BrotliDecoder.Decompress Method

Definition

Namespace:

System.IO.Compression

Assembly:

System.IO.Compression.Brotli.dll

Source:

BrotliDecoder.cs

Decompresses data that was compressed using the Brotli algorithm.

public:
 System::Buffers::OperationStatus Decompress(ReadOnlySpan<System::Byte> source, Span<System::Byte> destination, [Runtime::InteropServices::Out] int % bytesConsumed, [Runtime::InteropServices::Out] int % bytesWritten);

public System.Buffers.OperationStatus Decompress (ReadOnlySpan<byte> source, Span<byte> destination, out int bytesConsumed, out int bytesWritten);

member this.Decompress : ReadOnlySpan<byte> * Span<byte> * int * int -> System.Buffers.OperationStatus

Public Function Decompress (source As ReadOnlySpan(Of Byte), destination As Span(Of Byte), ByRef bytesConsumed As Integer, ByRef bytesWritten As Integer) As OperationStatus

Parameters

source

ReadOnlySpan<Byte>

A buffer containing the compressed data.

destination

Span<Byte>

When this method returns, a byte span containing the decompressed data.

bytesConsumed

Int32

The total number of bytes that were read from source.

bytesWritten

Int32

The total number of bytes that were written in the destination.

Returns

OperationStatus

One of the enumeration values that indicates the status of the decompression operation.

Remarks

The return value can be as follows: - Done: source was successfully and completely decompressed into destination. - DestinationTooSmall: There is not enough space in destination to decompress source. - NeedMoreData: The decompression action is partially done at least one more byte is required to complete the decompression task. This method should be called again with more input to decompress. - InvalidData: The data in source is invalid and could not be decompressed.