DeflateStream.Read Метод

Определение

Перегрузки

Read(Span<Byte>)

Считывает последовательность байтов из текущего потока Deflate в диапазон байтов и перемещает позицию внутри потока Deflate на число считанных байтов.Reads a sequence of bytes from the current Deflate stream into a byte span and advances the position within the Deflate 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>)

Считывает последовательность байтов из текущего потока Deflate в диапазон байтов и перемещает позицию внутри потока Deflate на число считанных байтов.Reads a sequence of bytes from the current Deflate stream into a byte span and advances the position within the Deflate 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

Параметры

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.

Возвращаемое значение

Int32

Общее число байтов, считанных в буфер.The total number of bytes read into the buffer. Это число может быть меньше количества выделенных в буфере байтов, если столько байтов в настоящее время недоступно, а также равняться нулю (0), если был достигнут конец потока.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.

Комментарии

Используйте свойство CanRead, чтобы определить, поддерживает ли текущий экземпляр чтение.Use the CanRead property to determine whether the current instance supports reading. Используйте метод ReadAsync для асинхронного чтения из текущего потока.Use the ReadAsync method to read asynchronously from the current stream.

Этот метод считывает максимум buffer.Length байт из текущего потока и сохраняет их в buffer.This method read a maximum of buffer.Length bytes from the current stream and store them in buffer. Текущая координата в потоке деспрямления увеличивается на число считанных байтов; Однако при возникновении исключения текущее место в потоке деспрямления остается неизменным.The current position within the Deflate stream is advanced by the number of bytes read; however, if an exception occurs, the current position within the Deflate 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 возвращает 0, только если в потоке больше нет данных и что больше не ожидается (например, закрытый сокет или конец файла).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.

Для чтения примитивных типов данных используйте BinaryReader.Use BinaryReader for reading primitive data types.

Read(Byte[], Int32, Int32)

Считывает число распакованных байтов в указанный массив байтов.Reads a number of decompressed bytes into the specified byte array.

public:
 override int Read(cli::array <System::Byte> ^ array, int offset, int count);
public override int Read (byte[] array, int offset, int count);
override this.Read : byte[] * int * int -> int
Public Overrides Function Read (array As Byte(), offset As Integer, count As Integer) As Integer

Параметры

array
Byte[]

Массив для хранения распакованных байтов.The array to store decompressed bytes.

offset
Int32

Смещение в байтах в массиве array, в который будут помещены считанные байты.The byte offset in array at which the read bytes will be placed.

count
Int32

Максимальное число распакованных байтов для считывания.The maximum number of decompressed bytes to read.

Возвращаемое значение

Int32

Число байтов, которые были считаны в массив байтов.The number of bytes that were read into the byte array.

Исключения

Параметр array равен null.array is null.

При создании объекта значение CompressionMode было равно Compress.The CompressionMode value was Compress when the object was created.

-или--or- Основной поток не поддерживает чтение.The underlying stream does not support reading.

Значение параметра offset или count меньше нуля.offset or count is less than zero.

-или--or- Длина массива array минус начальная точка индекса меньше чем count.array length minus the index starting point is less than count.

Недопустимый формат данных.The data is in an invalid format.

Поток закрыт.The stream is closed.

Примеры

В следующем примере показано, как сжимать и распаковать байты с помощью методов Read и Write.The following example shows how to compress and decompress bytes by using the Read and Write methods.

using System;
using System.Text;
using System.IO;
using System.IO.Compression;

namespace ExampleConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            UnicodeEncoding uniEncode = new UnicodeEncoding();

            byte[] bytesToCompress = uniEncode.GetBytes("example text to compress and decompress");
            Console.WriteLine("starting with: " + uniEncode.GetString(bytesToCompress));

            using (FileStream fileToCompress = File.Create("examplefile.gz"))
            {
                using (DeflateStream compressionStream = new DeflateStream(fileToCompress, CompressionMode.Compress))
                {
                    compressionStream.Write(bytesToCompress, 0, bytesToCompress.Length);
                }
            }

            byte[] decompressedBytes = new byte[bytesToCompress.Length];
            using (FileStream fileToDecompress = File.Open("examplefile.gz", FileMode.Open))
            {
                using (DeflateStream decompressionStream = new DeflateStream(fileToDecompress, CompressionMode.Decompress))
                {
                    decompressionStream.Read(decompressedBytes, 0, bytesToCompress.Length);
                }
            }

            Console.WriteLine("ending with: " + uniEncode.GetString(decompressedBytes));
        }
    }
}
Imports System.IO
Imports System.IO.Compression
Imports System.Text

Module Module1

    Sub Main()
        Dim uniEncode As UnicodeEncoding = New UnicodeEncoding()

        Dim bytesToCompress = uniEncode.GetBytes("example text to compress and decompress")
        Console.WriteLine("starting with: " + uniEncode.GetString(bytesToCompress))

        Using fileToCompress As FileStream = File.Create("examplefile.gz")
            Using compressionStream As DeflateStream = New DeflateStream(fileToCompress, CompressionMode.Compress)
                compressionStream.Write(bytesToCompress, 0, bytesToCompress.Length)
            End Using
        End Using

        Dim decompressedBytes(bytesToCompress.Length - 1) As Byte
        Using fileToDecompress As FileStream = File.Open("examplefile.gz", FileMode.Open)
            Using decompressionStream As DeflateStream = New DeflateStream(fileToDecompress, CompressionMode.Decompress)
                decompressionStream.Read(decompressedBytes, 0, bytesToCompress.Length)
            End Using
        End Using

        Console.WriteLine("ending with: " + uniEncode.GetString(decompressedBytes))
    End Sub
End Module

Применяется к