BrotliStream.Read Method

Definition

Namespace:

System.IO.Compression

Assembly:

System.IO.Compression.Brotli.dll

Overloads

Read(Span<Byte>)	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.
Read(Byte[], Int32, Int32)	Reads a number of decompressed bytes into the specified byte array.

Read(Span<Byte>)

Source:

BrotliStream.Decompress.cs

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.

public:
 override int Read(Span<System::Byte> buffer);

public override int Read (Span<byte> buffer);

override this.Read : Span<byte> -> int

Public Overrides Function Read (buffer As Span(Of Byte)) As Integer

Parameters

buffer

Span<Byte>

A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.

Returns

Int32

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.

Remarks

Use the CanRead property to determine whether the current instance supports reading. Use the System.IO.Compression.BrotliStream.ReadAsync method to read asynchronously from the current stream.

This method read a maximum of `buffer.Length` bytes from the current stream and store them in buffer. The current position within the Brotli stream is advanced by the number of bytes read; however, if an exception occurs, the current position within the Brotli stream remains unchanged. This method will block until at least one byte of data can be read, in the event that no data is available. `Read` returns 0 only when there is no more data in the stream and no more is expected (such as a closed socket or end of file). The method is free to return fewer bytes than requested even if the end of the stream has not been reached.

Use BinaryReader for reading primitive data types.

Read(Byte[], Int32, Int32)

Source:

BrotliStream.Decompress.cs

Reads a number of decompressed bytes into the specified byte array.

public:
 override int Read(cli::array <System::Byte> ^ buffer, int offset, int count);

public override int Read (byte[] buffer, int offset, int count);

override this.Read : byte[] * int * int -> int

Public Overrides Function Read (buffer As Byte(), offset As Integer, count As Integer) As Integer

Parameters

buffer

Byte[]

The array used to store decompressed bytes.

offset

Int32

The byte offset in buffer at which the read bytes will be placed.

count

Int32

The maximum number of decompressed bytes to read.

Returns

Int32

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.

Exceptions

ArgumentNullException

buffer is null.

InvalidOperationException

The CompressionMode value was Compress when the object was created, or there is already an active asynchronous operation on this stream.

ArgumentOutOfRangeException

offset or count is less than zero.

ArgumentException

The buffer length minus the index starting point is less than count.

InvalidDataException

The data is in an invalid format.

ObjectDisposedException

The underlying stream is null or closed.