BrotliStream 類別

定義

命名空間:

System.IO.Compression

組件:

netstandard.dll, System.IO.Compression.Brotli.dll

來源:

BrotliStream.cs

提供使用 Brotli 資料格式規格壓縮和解壓縮數據流的方法和屬性。

public ref class BrotliStream sealed : System::IO::Stream

public sealed class BrotliStream : System.IO.Stream

type BrotliStream = class
    inherit Stream

Public NotInheritable Class BrotliStream
Inherits Stream

繼承

Object

MarshalByRefObject

Stream

BrotliStream

建構函式

名稱	Description
BrotliStream(Stream, BrotliCompressionOptions, Boolean)	透過指定的串流與壓縮選項初始化類別的新實例 BrotliStream ，並可選擇性地保持串流開啟。
BrotliStream(Stream, CompressionLevel, Boolean)	透過指定的串流與壓縮等級初始化該類別的新實例 BrotliStream ，並可選擇性地保持串流開啟。
BrotliStream(Stream, CompressionLevel)	透過使用指定的串流與壓縮等級初始化該類別的新 BrotliStream 實例。
BrotliStream(Stream, CompressionMode, Boolean)	透過指定的串流與壓縮模式初始化類別的新實例 BrotliStream ，並可選擇性地保持串流開啟。
BrotliStream(Stream, CompressionMode)	透過指定的串流與壓縮模式初始化該類別的新 BrotliStream 實例。

屬性

名稱	Description
BaseStream	會得到底層串流的參考。
CanRead	會取得一個值，表示串流在解壓縮檔案時是否支援讀取。
CanSeek	會獲得一個值，表示該串流是否支援尋道。
CanTimeout	取得值，這個值會判斷目前的數據流是否可以逾時。 (繼承來源 Stream)
CanWrite	會有一個值，表示串流是否支援寫入。
Length	此性質不被支持，且總是拋出 。NotSupportedException
Position	此性質不被支持，且總是拋出 。NotSupportedException
ReadTimeout	會取得或設定一個以毫秒為單位的值，決定串流在逾時前嘗試讀取的時間長短。 (繼承來源 Stream)
WriteTimeout	取得或設定一個毫秒級的值，決定串流在逾時前嘗試寫入的時間長短。 (繼承來源 Stream)

方法

名稱	Description
BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	開始異步讀取作業。 （考慮改用這個 ReadAsync(Byte[], Int32, Int32) 方法。）
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	開始異步寫入作業。 （考慮改用這個 WriteAsync(Byte[], Int32, Int32) 方法。）
Close()	關閉目前串流並釋放與目前串流相關的資源（如套接字和檔案柄）。 與其呼叫此方法，不如確保溪流已被妥善處理。 (繼承來源 Stream)
CopyTo(Stream, Int32)	從目前串流讀取位元組，並依指定緩衝區大小寫入另一串流。 兩個串流的位置依複製的位元組數前進。 (繼承來源 Stream)
CopyTo(Stream)	從目前串流讀取位元組，然後寫入另一條串流。 兩個串流的位置依複製的位元組數前進。 (繼承來源 Stream)
CopyToAsync(Stream, CancellationToken)	使用指定的取消標記，以異步方式從目前數據流讀取位元組，並將其寫入另一個數據流。 兩個串流的位置依複製的位元組數前進。 (繼承來源 Stream)
CopyToAsync(Stream, Int32, CancellationToken)	非同步地從目前串流讀取位元組，並使用指定的緩衝區大小與取消標記寫入另一串流。 兩個串流的位置依複製的位元組數前進。 (繼承來源 Stream)
CopyToAsync(Stream, Int32)	非同步讀取目前串流的位元組，並以指定的緩衝區大小寫入另一串流。 兩個串流的位置依複製的位元組數前進。 (繼承來源 Stream)
CopyToAsync(Stream)	非同步地從目前串流讀取位元組，然後寫入另一條串流。 兩個串流的位置依複製的位元組數前進。 (繼承來源 Stream)
CreateWaitHandle()	已淘汰. 分配一個 WaitHandle 物件。 (繼承來源 Stream)
Dispose()	釋放 Stream所使用的所有資源。 (繼承來源 Stream)
Dispose(Boolean)	釋放 未管理的資源， Stream 並可選擇性地釋放受管理資源。 (繼承來源 Stream)
DisposeAsync()	非同步釋放 BrotliStream.
EndRead(IAsyncResult)	等候暫止的異步讀取完成。 （考慮改用這個 ReadAsync(Byte[], Int32, Int32) 方法。）
EndWrite(IAsyncResult)	處理非同步寫入操作的結束。 （考慮改用這個 WriteAsync(Byte[], Int32, Int32) 方法。）
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
Flush()	如果串流未被處理，且壓縮模式設為壓縮，則會將剩餘編碼器的資料寫入此串流。
FlushAsync()	非同步清除此串流的所有緩衝區，並使任何緩衝資料寫入底層裝置。 (繼承來源 Stream)
FlushAsync(CancellationToken)	非同步清除該 Brotli 串流的所有緩衝區，導致任何緩衝資料寫入底層裝置，並監控取消請求。
GetHashCode()	做為預設哈希函式。 (繼承來源 Object)
GetLifetimeService()	已淘汰. 擷取控制這個實例存留期原則的目前存留期服務物件。 (繼承來源 MarshalByRefObject)
GetType()	取得目前實例的 Type。 (繼承來源 Object)
InitializeLifetimeService()	已淘汰. 取得存留期服務物件，以控制這個實例的存留期原則。 (繼承來源 MarshalByRefObject)
MemberwiseClone()	建立目前 Object的淺層複本。 (繼承來源 Object)
MemberwiseClone(Boolean)	建立目前 MarshalByRefObject 對象的淺層複本。 (繼承來源 MarshalByRefObject)
ObjectInvariant()	已淘汰. 提供 。Contract (繼承來源 Stream)
Read(Byte[], Int32, Int32)	將若干解壓縮的位元組讀取到指定的位元組陣列中。
Read(Span<Byte>)	從目前 Brotli 串流讀取一串位元組到位元組區間，並依讀取位元組數推進 Brotli 串流中的位置。
ReadAsync(Byte[], Int32, Int32, CancellationToken)	非同步讀取目前 Brotli 串流的一串位元組，將它們寫入從指定索引開始的位元組陣列，依讀取位元組數推進 Brotli 串流中的位置，並監控取消請求。
ReadAsync(Byte[], Int32, Int32)	非同步讀取當前串流的位元組序列，並依讀取位元組數推進串流中的位置。 (繼承來源 Stream)
ReadAsync(Memory<Byte>, CancellationToken)	非同步讀取目前 Brotli 串流中的一串位元組，將它們寫入位元組記憶體範圍，依讀取位元組數推進 Brotli 串流中的位置，並監控取消請求。
ReadAtLeast(Span<Byte>, Int32, Boolean)	從目前數據流讀取至少一個字節數目，並將數據流中的位置依讀取的位元組數目往前移。 (繼承來源 Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	以異步方式從目前數據流讀取至少一個字節數目、依讀取的位元組數目將數據流中的位置往前移，並監視取消要求。 (繼承來源 Stream)
ReadByte()	從串流讀取一個位元組，並將串流中的位置往前推進一個位元組，若在串流末端則返回 -1。
ReadExactly(Byte[], Int32, Int32)	從目前串流讀取 count 位元組數，並推進串流中的位置。 (繼承來源 Stream)
ReadExactly(Span<Byte>)	從目前串流讀取位元組，並推進串流中的位置直到填 buffer 滿。 (繼承來源 Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	非同步讀取 count 當前串流的位元組數量，推進串流中的位置，並監控取消請求。 (繼承來源 Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	非同步讀取目前串流的位元組，推進串流中的位置直到填 buffer 滿，並監控取消請求。 (繼承來源 Stream)
Seek(Int64, SeekOrigin)	此性質不被支持，且總是拋出 。NotSupportedException
SetLength(Int64)	此性質不被支持，且總是拋出 。NotSupportedException
ToString()	傳回表示目前 物件的字串。 (繼承來源 Object)
Write(Byte[], Int32, Int32)	從指定的位元組陣列將壓縮的位元組寫入底層串流。
Write(ReadOnlySpan<Byte>)	從只讀位元組區間寫入一串位元組到目前 Brotli 串流，並依寫入位元組數將目前位置前進。
WriteAsync(Byte[], Int32, Int32, CancellationToken)	非同步地從指定的位元組陣列寫入壓縮後的 Brotli 串流。
WriteAsync(Byte[], Int32, Int32)	非同步地將一串位元組寫入目前串流，並依照寫入的位元組數將該串流中的當前位置往前推進。 (繼承來源 Stream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	非同步地將壓縮的位元組寫入底層的 Brotli 串流，從指定的位元組記憶體範圍中。
WriteByte(Byte)	將位元組寫入數據流中的目前位置，並將數據流中的位置往前移一個字節。

擴充方法

名稱	Description
ConfigureAwait(IAsyncDisposable, Boolean)	設定如何執行從異步可處置專案傳回的工作等候。
CopyToAsync(Stream, PipeWriter, CancellationToken)	非同步讀取 的 Stream 位元組並使用消去標記寫入指定的 PipeWriter。