GZipStream.Read Méthode

Définition

Espace de noms:

System.IO.Compression

Assembly:

System.IO.Compression.dll

Surcharges

Read(Span<Byte>)	Lit une séquence d’octets à partir du flux GZip actuel dans une étendue d’octets et avance la position dans le flux GZip du nombre d’octets lus.
Read(Byte[], Int32, Int32)	Lit un certain nombre d'octets décompressés dans le tableau d'octets spécifié.

Read(Span<Byte>)

Source:

GZipStream.cs

Lit une séquence d’octets à partir du flux GZip actuel dans une étendue d’octets et avance la position dans le flux GZip du nombre d’octets lus.

C#

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

Paramètres

buffer

Span<Byte>

Région de la mémoire. Quand cette méthode est retournée, le contenu de cette région est remplacé par les octets lus dans la source actuelle.

Retours

Int32

Nombre total d'octets lus dans la mémoire tampon. Le nombre d’octets peut être inférieur au nombre d’octets alloués dans la mémoire tampon si ce nombre d’octets n’est pas actuellement disponible, ou égal à zéro (0) si la fin du flux a été atteinte.

Remarques

Important

À compter de .NET 6, cette méthode peut ne pas lire autant d’octets que demandé. Pour plus d’informations, consultez Lectures partielles et zéro octets dans DeflateStream, GZipStream et CryptoStream.

Utilisez la CanRead propriété pour déterminer si le instance actuel prend en charge la lecture. Utilisez la ReadAsync méthode pour lire de manière asynchrone à partir du flux actuel.

Cette méthode lit un maximum d’octets buffer.Length du flux actuel et les stocke dans buffer. La position actuelle dans le flux GZip est avancée par le nombre d’octets lus ; Toutefois, si une exception se produit, la position actuelle dans le flux GZip reste inchangée. Dans le cas où aucune donnée n’est disponible, cette méthode se bloque jusqu’à ce qu’au moins un octet de données puisse être lu. Read retourne 0 uniquement lorsqu’il n’y a plus de données dans le flux et qu’aucune autre donnée n’est attendue (par exemple, un socket fermé ou la fin du fichier). La méthode est libre de retourner moins d’octets que demandé même si la fin du flux n’a pas été atteinte.

À utiliser BinaryReader pour lire les types de données primitifs.

Read(Byte[], Int32, Int32)

Source:

GZipStream.cs

Lit un certain nombre d'octets décompressés dans le tableau d'octets spécifié.

C#

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

Paramètres

buffer

Byte[]

Tableau utilisé pour décompresser les octets.

offset

Int32

Décalage d’octets au niveau duquel les octets lus seront placés.

count

Int32

Nombre maximal d'octets décompressés à lire.

Retours

Int32

Nombre d'octets qui ont été décompressés dans le tableau d'octets. Si la fin du flux a été atteinte, zéro ou le nombre d'octets lus est retourné.

Exceptions

ArgumentNullException

array ou buffer est null.

InvalidOperationException

La valeur CompressionMode était Compress quand l’objet a été créé.

- ou -

Le flux sous-jacent ne prend pas en charge la lecture.

ArgumentOutOfRangeException

offset ou count est inférieur à zéro.

- ou -

array ou buffer la longueur moins le point de départ de l’index est inférieure à count.

InvalidDataException

Le format des données n’est pas valide.

ObjectDisposedException

Le flux est fermé.

Exemples

L’exemple suivant montre comment compresser et décompresser des octets à l’aide des Read méthodes et Write .

C#

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;
    }
}

Remarques

Important

À compter de .NET 6, cette méthode peut ne pas lire autant d’octets que demandé. Pour plus d’informations, consultez Lectures partielles et zéro octets dans DeflateStream, GZipStream et CryptoStream.

Si des données sont trouvées dans un format non valide, une InvalidDataException est levée. Une case activée de redondance cyclique (CRC) est effectuée comme l’une des dernières opérations de cette méthode.