GZipStream.Read Yöntem

Tanım

Ad Alanı:

System.IO.Compression

Bütünleştirilmiş Kod:

System.IO.Compression.dll

Aşırı Yüklemeler

Read(Span<Byte>)	Geçerli GZip akışından bayt dizisini bayt aralığına okur ve GZip akışındaki konumu okunan bayt sayısına göre ilerler.
Read(Byte[], Int32, Int32)	Belirtilen bayt dizisine bir dizi sıkıştırılmış bayt okur.

Read(Span<Byte>)

Kaynak:

GZipStream.cs

Geçerli GZip akışından bayt dizisini bayt aralığına okur ve GZip akışındaki konumu okunan bayt sayısına göre ilerler.

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

Parametreler

buffer

Span<Byte>

Bellek bölgesi. Bu yöntem döndürdüğünde, bu bölgenin içeriği geçerli kaynaktan okunan baytlar ile değiştirilir.

Döndürülenler

Int32

Arabelleğe okunan toplam bayt sayısı. Bu, arabellekte ayrılan bayt sayısından az veya akışın sonuna ulaşıldıysa sıfır (0) olabilir.

Açıklamalar

Önemli

.NET 6'dan başlayarak, bu yöntem istenen sayıda bayt okumayabilir. Daha fazla bilgi için bkz. DeflateStream, GZipStream ve CryptoStream'de kısmi ve sıfır bayt okumaları.

CanRead Geçerli örneğin okumayı destekleyip desteklemediğini belirlemek için özelliğini kullanın. ReadAsync Geçerli akıştan zaman uyumsuz olarak okumak için yöntemini kullanın.

Bu yöntem geçerli akıştan en fazla buffer.Length bayt sayısını okur ve içinde bufferdepolar. GZip akışındaki geçerli konum, okunan bayt sayısıyla gelişmiştir; ancak bir özel durum oluşursa, GZip akışındaki geçerli konum değişmeden kalır. Kullanılabilir veri olmaması durumunda, bu yöntem en az bir bayt veri okunana kadar engeller. Read yalnızca akışta daha fazla veri olmadığında ve başka veri beklenmezse (kapalı yuva veya dosya sonu gibi) 0 döndürür. yöntemi, akışın sonuna ulaşılmasa bile istenenden daha az bayt döndürmek için ücretsizdir.

Temel veri türlerini okumak için kullanın BinaryReader .

Read(Byte[], Int32, Int32)

Kaynak:

GZipStream.cs

Belirtilen bayt dizisine bir dizi sıkıştırılmış bayt okur.

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

Parametreler

buffer

Byte[]

Sıkıştırılmış baytları depolamak için kullanılan dizi.

offset

Int32

Okuma baytlarının yerleştirileceği bayt uzaklığı.

count

Int32

Okunacak sıkıştırılmış bayt sayısı üst sınırı.

Döndürülenler

Int32

Bayt dizisine sıkıştırılan bayt sayısı. Akışın sonuna ulaşıldıysa, sıfır veya okunan bayt sayısı döndürülür.

Özel durumlar

ArgumentNullException

array veya buffer şeklindedir null.

InvalidOperationException

CompressionMode Değer, nesnenin oluşturulduğu zamandıCompress.

-veya-

Temel alınan akış okumayı desteklemez.

ArgumentOutOfRangeException

offset veya count sıfırdan küçüktür.

-veya-

array veya buffer uzunluk eksi dizin başlangıç noktası değerinden countküçüktür.

InvalidDataException

Veriler geçersiz biçimde.

ObjectDisposedException

Akış kapatılır.

Örnekler

Aşağıdaki örnekte ve Write yöntemlerini kullanarak Read baytları sıkıştırma ve açma işlemleri gösterilmektedir.

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

Açıklamalar

Önemli

.NET 6'dan başlayarak, bu yöntem istenen sayıda bayt okumayabilir. Daha fazla bilgi için bkz. DeflateStream, GZipStream ve CryptoStream'de kısmi ve sıfır bayt okumaları.

Veriler geçersiz biçimde bulunursa, bir InvalidDataException oluşturulur. Döngüsel yedeklilik denetimi (CRC), bu yöntemin son işlemlerinden biri olarak gerçekleştirilir.