HostedFileDownloadStream 類別

定義

命名空間:

Microsoft.Extensions.AI

組件:

Microsoft.Extensions.AI.Abstractions.dll

套件:

Microsoft.Extensions.AI.Abstractions v10.4.1

來源:

HostedFileDownloadStream.cs

代表一個串流，用於從 AI 服務下載檔案內容。

public ref class HostedFileDownloadStream abstract : System::IO::Stream

[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public abstract class HostedFileDownloadStream : System.IO.Stream

[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type HostedFileDownloadStream = class
    inherit Stream

Public MustInherit Class HostedFileDownloadStream
Inherits Stream

繼承

Object

Stream

HostedFileDownloadStream

屬性

ExperimentalAttribute

備註

此抽象類別可 Stream 擴充提供下載檔案的額外元資料，例如其媒體類型與檔名。 實作應覆寫 Stream 抽象成員，並可 MediaType 選擇覆蓋並提供 FileName 檔案元資料。

此 ToDataContentAsync(CancellationToken) 方法提供了一種方便的方式，可以將整個串流內容緩衝到一個 DataContent 實例中。

建構函式

名稱	Description
HostedFileDownloadStream()	初始化 HostedFileDownloadStream 類別的新執行個體。

屬性

名稱	Description
CanWrite	在衍生類別中覆寫時，取得值，指出目前數據流是否支援寫入。
FileName	取得檔案名稱。
MediaType	取得檔案內容的媒體類型（MIME 類型）。

方法

名稱	Description
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	開始異步寫入作業。 （考慮改用 WriteAsync(Byte[], Int32, Int32) 。）
EndWrite(IAsyncResult)	結束異步寫入作業。 （考慮改用 WriteAsync(Byte[], Int32, Int32) 。）
SetLength(Int64)	當在派生類別中覆寫時，會設定目前串流的長度。
ToDataContentAsync(CancellationToken)	從目前位置讀取整個串流內容，並以 DataContent.
Write(Byte[], Int32, Int32)	在衍生類別中覆寫時，將位元組序列寫入目前數據流，並依寫入的位元組數目將這個數據流中的目前位置往前移。
Write(ReadOnlySpan<Byte>)	在衍生類別中覆寫時，將位元組序列寫入目前數據流，並依寫入的位元組數目將這個數據流中的目前位置往前移。
WriteAsync(Byte[], Int32, Int32, CancellationToken)	以異步方式將位元組序列寫入至目前的數據流、依寫入的位元組數目將這個數據流中的目前位置往前移，並監視取消要求。
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	以異步方式將位元組序列寫入至目前的數據流、依寫入的位元組數目將這個數據流中的目前位置往前移，並監視取消要求。
WriteByte(Byte)	將位元組寫入數據流中的目前位置，並將數據流中的位置往前移一個字節。

擴充方法

名稱	Description
CopyToAsync(Stream, PipeWriter, CancellationToken)	非同步讀取 的 Stream 位元組並使用消去標記寫入指定的 PipeWriter。