GZipStream.ReadAsync Metoda

Definice

Obor názvů:

System.IO.Compression

Sestavení:

System.IO.Compression.dll

Přetížení

ReadAsync(Memory<Byte>, CancellationToken)	Asynchronně přečte posloupnost bajtů z aktuálního datového proudu GZip do oblasti paměti bajtů, posune pozici v rámci datového proudu GZip o počet přečtených bajtů a monitoruje požadavky na zrušení.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně přečte posloupnost bajtů z aktuálního datového proudu GZip do pole bajtů, posune pozici v rámci datového proudu GZip o počet přečtených bajtů a monitoruje požadavky na zrušení.

ReadAsync(Memory<Byte>, CancellationToken)

Zdroj:

GZipStream.cs

Asynchronně přečte posloupnost bajtů z aktuálního datového proudu GZip do oblasti paměti bajtů, posune pozici v rámci datového proudu GZip o počet přečtených bajtů a monitoruje požadavky na zrušení.

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parametry

buffer

Memory<Byte>

Oblast paměti, do které chcete data zapsat.

cancellationToken

CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

ValueTask<Int32>

Úloha, která představuje asynchronní operaci čtení, která zabalí celkový počet přečtených bajtů do vyrovnávací paměti. Výsledná hodnota může být menší než počet bajtů přidělených ve vyrovnávací paměti, pokud tento počet bajtů není aktuálně k dispozici, nebo může být 0 (nula), pokud bylo dosaženo konce datového proudu GZip.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Důležité

Počínaje verzí .NET 6 nemusí tato metoda číst tolik bajtů, kolik bylo požadováno. Další informace najdete v tématu Částečné a nulové bajtové čtení v deflateStream, GZipStream a CryptoStream.

Metoda ReadAsync umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je obzvláště důležitý v desktopových aplikacích, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

CanRead Pomocí vlastnosti určete, jestli aktuální instance podporuje čtení.

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat TaskStatus.Canceled hodnotu vlastnosti Task.Status .

ReadAsync(Byte[], Int32, Int32, CancellationToken)

Zdroj:

GZipStream.cs

Asynchronně přečte posloupnost bajtů z aktuálního datového proudu GZip do pole bajtů, posune pozici v rámci datového proudu GZip o počet přečtených bajtů a monitoruje požadavky na zrušení.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parametry

buffer

Byte[]

Vyrovnávací paměť pro zápis dat.

offset

Int32

Posun bajtů, při kterém se mají začít zapisovat data z datového proudu GZip.

count

Int32

Maximální počet bajtů ke čtení.

cancellationToken

CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

Task<Int32>

Úloha, která představuje asynchronní operaci čtení, která zabalí celkový počet přečtených bajtů. Výsledná hodnota může být menší než počet požadovaných bajtů, pokud je počet aktuálně dostupných bajtů menší než požadovaný počet, nebo může být 0 (nula), pokud bylo dosaženo konce datového proudu GZip.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Důležité

Počínaje verzí .NET 6 nemusí tato metoda číst tolik bajtů, kolik bylo požadováno. Další informace najdete v tématu Částečné a nulové bajtové čtení v deflateStream, GZipStream a CryptoStream.

Metoda ReadAsync umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je obzvláště důležitý v desktopových aplikacích, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

CanRead Pomocí vlastnosti určete, jestli aktuální instance podporuje čtení.

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat TaskStatus.Canceled hodnotu vlastnosti Task.Status .

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem Read(Byte[], Int32, Int32).