BrotliStream.Read Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
- Source:
- BrotliStream.Decompress.cs
- 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> -> intPublic Overrides Function Read (buffer As Span(Of Byte)) As IntegerParameters
A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.
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.
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.
Applies to
Read(Byte[], Int32, Int32)
- Source:
- BrotliStream.Decompress.cs
- Source:
- BrotliStream.Decompress.cs
- 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 -> intPublic Overrides Function Read (buffer As Byte(), offset As Integer, count As Integer) As IntegerParameters
- 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
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
buffer is null.
The CompressionMode value was Compress when the object was created, or there is already an active asynchronous operation on this stream.
offset or count is less than zero.
The buffer length minus the index starting point is less than count.
The data is in an invalid format.
The underlying stream is null or closed.
