Struct OnDropBody 

pub struct OnDropBody<B, F>
where
    F: FnOnce(),
{ /* private fields */ }

A StreamingBody wrapper that calls a closure when dropped before the body is fully consumed.

The closure fires if the body is dropped before StreamingBody::poll_frame returns Poll::Ready(None). A common cause is a client disconnecting mid-response (e.g. during a streaming or SSE endpoint).

The closure is called exactly once: it is disarmed when the stream is exhausted normally, so it only fires on early drops.

Example

use rama_http_types::body::{Body, OnDropBody};

let body = Body::from("hello world");
let wrapped = Body::new(OnDropBody::new(body, || {
    // client disconnected before the response was fully sent
}));

Or via the [Body::on_drop] convenience method:

use rama_http_types::body::Body;

let body = Body::from("hello world").on_drop(|| {
    // client disconnected before the response was fully sent
});

Implementations

impl<B, F> OnDropBody<B, F>

where F: FnOnce(),

pub fn new(inner: B, on_drop: F) -> OnDropBody<B, F>

Wrap inner with a drop callback.

on_drop is called once if the body is dropped before StreamingBody::poll_frame returns Poll::Ready(None).

Trait Implementations

impl<B, F> Body for OnDropBody<B, F>

where B: Body, F: FnOnce(),

type Data = <B as Body>::Data

Values yielded by the Body.

type Error = <B as Body>::Error

The error type this Body might generate.

fn poll_frame( self: Pin<&mut OnDropBody<B, F>>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<<OnDropBody<B, F> as Body>::Data>, <OnDropBody<B, F> as Body>::Error>>>

Attempt to pull out the next frame of this stream.

fn is_end_stream(&self) -> bool

A hint that may return true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

A hint that returns the bounds on the remaining length of the stream.

impl<'__pin, B, F> Unpin for OnDropBody<B, F>

where F: FnOnce(), <PinnedFieldsOfHelperStruct<__Origin<'__pin, B, F>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,