GZipStream.Read Metoda

Definice

Obor názvů:

System.IO.Compression

Sestavení:

netstandard.dll, System.IO.Compression.dll

Přetížení

Name	Description
Read(Span<Byte>)	Přečte posloupnost bajtů z aktuálního datového proudu GZip do bajtového rozsahu a posune pozici v rámci datového proudu GZip o počet přečtených bajtů.
Read(Byte[], Int32, Int32)	Načte řadu dekomprimovaných bajtů do zadaného bajtového pole.

Read(Span<Byte>)

Zdroj:

GZipStream.cs

Přečte posloupnost bajtů z aktuálního datového proudu GZip do bajtového rozsahu a posune pozici v rámci datového proudu GZip o počet přečtených bajtů.

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

Parametry

buffer

Span<Byte>

Oblast paměti. Když tato metoda vrátí, obsah této oblasti se nahradí bajty načtenými z aktuálního zdroje.

Návraty

Int32

Celkový počet bajtů přečtených do vyrovnávací paměti. To může být menší než počet bajtů přidělených ve vyrovnávací paměti, pokud není aktuálně k dispozici mnoho bajtů, nebo nula (0), pokud bylo dosaženo konce datového proudu.

Poznámky

Důležité

Od verze .NET 6 nemusí tato metoda číst tolik bajtů, kolik bylo požadováno. Další informace naleznete v tématu Částečné a nulové bajty čtení v DeflateStream, GZipStream a CryptoStream.

CanRead Pomocí vlastnosti určete, zda aktuální instance podporuje čtení. ReadAsync Pomocí metody můžete číst asynchronně z aktuálního datového proudu.

Tato metoda čte maximální počet bajtů z aktuálního datového buffer.Length proudu a ukládá je do buffer. Aktuální pozice v rámci datového proudu GZip je rozšířena počtem bajtů čtení; Pokud však dojde k výjimce, aktuální pozice v rámci datového proudu GZip zůstane beze změny. V případě, že nejsou k dispozici žádná data, tato metoda blokuje, dokud nebude možné číst alespoň jeden bajt dat. Read vrátí hodnotu 0 pouze v případě, že v datovém proudu nejsou žádná další data a už se neočekává (například uzavřený soket nebo konec souboru). Metoda je zdarma vrátit méně bajtů, než je požadováno, i když nebyl dosažen konec datového proudu.

Slouží BinaryReader ke čtení primitivních datových typů.

Read(Byte[], Int32, Int32)

Zdroj:

GZipStream.cs

Načte řadu dekomprimovaných bajtů do zadaného bajtového pole.

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

Parametry

buffer

Byte[]

Pole použité k ukládání dekomprimovaných bajtů.

offset

Int32

Posun bajtu, na kterém budou umístěny bajty čtení.

count

Int32

Maximální počet dekomprimovaných bajtů, které se mají číst.

Návraty

Int32

Počet bajtů, které byly dekomprimovány do bajtového pole. Pokud byl dosažen konec datového proudu, vrátí se nula nebo počet přečtených bajtů.

Výjimky

ArgumentNullException

array nebo buffer je null.

InvalidOperationException

Hodnota CompressionMode byla Compress při vytvoření objektu.

nebo

Základní datový proud nepodporuje čtení.

ArgumentOutOfRangeException

offset nebo count je menší než nula.

nebo

array nebo buffer délka minus počáteční bod indexu je menší než count.

InvalidDataException

Data jsou v neplatném formátu.

ObjectDisposedException

Stream je zavřený.

Příklady

Následující příklad ukazuje, jak komprimovat a dekomprimovat bajty pomocí Read a Write metod.

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

public static class MemoryWriteReadExample
{
    private const string Message = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.";
    private static readonly byte[] s_messageBytes = Encoding.ASCII.GetBytes(Message);

    public static void Run()
    {
        Console.WriteLine($"The original string length is {s_messageBytes.Length} bytes.");
        using var stream = new MemoryStream();
        CompressBytesToStream(stream);
        Console.WriteLine($"The compressed stream length is {stream.Length} bytes.");
        int decompressedLength = DecompressStreamToBytes(stream);
        Console.WriteLine($"The decompressed string length is {decompressedLength} bytes, same as the original length.");
        /*
         Output:
            The original string length is 445 bytes.
            The compressed stream length is 282 bytes.
            The decompressed string length is 445 bytes, same as the original length.
        */
    }

    private static void CompressBytesToStream(Stream stream)
    {
        using var compressor = new GZipStream(stream, CompressionLevel.SmallestSize, leaveOpen: true);
        compressor.Write(s_messageBytes, 0, s_messageBytes.Length);
    }

    private static int DecompressStreamToBytes(Stream stream)
    {
        stream.Position = 0;
        int bufferSize = 512;
        byte[] buffer = new byte[bufferSize];
        using var gzipStream = new GZipStream(stream, CompressionMode.Decompress);

        int totalRead = 0;
        while (totalRead < buffer.Length)
        {
            int bytesRead = gzipStream.Read(buffer.AsSpan(totalRead));
            if (bytesRead == 0) break;
            totalRead += bytesRead;
        }

        return totalRead;
    }
}

open System.IO
open System.IO.Compression
open System.Text

let message =
    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

let s_messageBytes = Encoding.ASCII.GetBytes message

let compressBytesToStream stream =
    use compressor =
        new GZipStream(stream, CompressionLevel.SmallestSize, leaveOpen = true)

    compressor.Write(s_messageBytes, 0, s_messageBytes.Length)

let decompressStreamToBytes (stream: Stream) =
    stream.Position <- 0
    let bufferSize = 512
    let decompressedBytes = Array.zeroCreate bufferSize
    use decompressor = new GZipStream(stream, CompressionMode.Decompress)
    decompressor.Read(decompressedBytes, 0, bufferSize)

[<EntryPoint>]
let main _ =
    printfn $"The original string length is {s_messageBytes.Length} bytes."
    use stream = new MemoryStream()
    compressBytesToStream stream
    printfn $"The compressed stream length is {stream.Length} bytes."
    let decompressedLength = decompressStreamToBytes stream
    printfn $"The decompressed string length is {decompressedLength} bytes, same as the original length."
    0

// Output:
//     The original string length is 445 bytes.
//     The compressed stream length is 282 bytes.
//     The decompressed string length is 445 bytes, same as the original length.

Imports System.IO
Imports System.IO.Compression
Imports System.Text

Module MemoryWriteReadExample
    Private Const Message As String = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
    Private ReadOnly s_messageBytes As Byte() = Encoding.ASCII.GetBytes(Message)

    Sub Main()
        Console.WriteLine($"The original string length is {s_messageBytes.Length} bytes.")

        Using stream = New MemoryStream()
            CompressBytesToStream(stream)
            Console.WriteLine($"The compressed stream length is {stream.Length} bytes.")
            Dim decompressedLength As Integer = DecompressStreamToBytes(stream)
            Console.WriteLine($"The decompressed string length is {decompressedLength} bytes, same as the original length.")
        End Using
        ' Output:
        '   The original string length is 445 bytes.
        '   The compressed stream length is 282 bytes.
        '   The decompressed string length is 445 bytes, same as the original length.
    End Sub

    Private Sub CompressBytesToStream(ByVal stream As Stream)
        Using compressor = New GZipStream(stream, CompressionLevel.SmallestSize, leaveOpen:=True)
            compressor.Write(s_messageBytes, 0, s_messageBytes.Length)
        End Using
    End Sub

    Private Function DecompressStreamToBytes(ByVal stream As Stream) As Integer
        stream.Position = 0
        Dim bufferSize As Integer = 512
        Dim decompressedBytes As Byte() = New Byte(bufferSize - 1) {}
        Using decompressor = New GZipStream(stream, CompressionMode.Decompress)
            Dim length As Integer = decompressor.Read(decompressedBytes, 0, bufferSize)
            Return length
        End Using
    End Function
End Module

Poznámky

Důležité

Od verze .NET 6 nemusí tato metoda číst tolik bajtů, kolik bylo požadováno. Další informace naleznete v tématu Částečné a nulové bajty čtení v DeflateStream, GZipStream a CryptoStream.

Pokud jsou data nalezena v neplatném formátu, InvalidDataException vyvolá se chyba. Kontrola cyklické redundance (CRC) se provádí jako jedna z posledních operací této metody.