Skip to main content

BodyWriter

Struct BodyWriter 

Source
pub struct BodyWriter { /* private fields */ }
Expand description

StreamingResponse::channel の producer 側ハンドル。

tokio::spawn したタスクへ move して使う想定の Send + 'static 型。 クローンして複数タスクから送信することもできる(mpsc::Sender の clone セマンティクスをそのまま継承。最後の 1 つが finish するか、 全クローンが finish を呼ばずに drop されるとチャネルが閉じる)。

Implementations§

Source§

impl BodyWriter

Source

pub async fn send(&self, data: Vec<u8>) -> Result<(), StreamClosed>

1 チャンク分のデータを送る。

チャネルが満杯(StreamingResponse::channel の capacity に到達)の 場合は受信側(コアの書き出しループ)がソケットへ書き出して空きが できるまで .await で停止する(バックプレッシャ、モジュール冒頭 doc)。

data が空の場合も呼び出し自体は成功するが、送出時に fandhe_backend_http::chunked::encode_chunk が無出力にする契約 のため実際のワイヤ出力は生じない(誤終端防止、同関数の doc を参照)。

§Errors

受信側が既に終了している場合は StreamClosed を返す。

Source

pub async fn finish(self) -> Result<(), StreamClosed>

ストリームを正常終端する。

受信側は fandhe_backend_http::chunked::encode_terminator を送出し、 応答を完全なものとして扱う(keep-alive 継続も許される)。self を 消費することで「finish 後に send を呼ぶ」という無意味な呼び出し 順序を型レベルで防ぐ。

finish を呼ばずに self を drop した場合は打ち切りとして扱われ、 受信側は終端チャンクを送らず接続をクローズする(モジュール冒頭 doc の「応答完全性」節を参照)。

§Errors

受信側が既に終了している場合は StreamClosed を返す。

Trait Implementations§

Source§

impl Clone for BodyWriter

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.