Struct AccountedBody 

struct AccountedBody {
    inner: Body,
    limiter: ServerMemoryLimiter,
    accounting: BodyMemoryAccounting,
    streamed: u64,
    incrementally_charged: u64,
    pre_charged: u64,
    pending: Option<(Frame<Bytes>, u64)>,
    pending_acquire: Option<Pin<Box<dyn Future<Output = Result<MemoryGuard<RequestMemoryMetrics>>> + Send>>>,
}

A request body wrapper that charges the shared limiter for every byte streamed beyond pre_charged (the upfront Content-Length reservation).

Fields

inner: Body

limiter: ServerMemoryLimiter

accounting: BodyMemoryAccounting

streamed: u64

Bytes of body data streamed so far.

incrementally_charged: u64

Bytes of the streamed body already covered by incremental permits.

pre_charged: u64

Bytes covered by the upfront Content-Length reservation.

pending: Option<(Frame<Bytes>, u64)>

A data frame held back while its permit is being acquired, together with the number of extra bytes to charge for it.

pending_acquire: Option<Pin<Box<dyn Future<Output = Result<MemoryGuard<RequestMemoryMetrics>>> + Send>>>

Implementations

impl AccountedBody

fn new( inner: Body, limiter: ServerMemoryLimiter, pre_charged: u64, accounting: BodyMemoryAccounting, ) -> Self

fn uncharged(&self) -> u64

Bytes that still need an incremental permit for the body streamed so far.

fn charge(&mut self, bytes: u64, cx: &mut Context<'_>) -> ChargeOutcome

Acquires a permit for bytes; only one acquisition may be in flight.

A parked acquisition always belongs to the currently buffered frame, so it must be resolved before any new acquisition is tried: letting the fast path succeed while a waiter is parked would leave the waiter alive, and its late completion would then be credited with another frame’s byte count (under-reserving memory relative to what is marked charged).

fn hand_out( &mut self, frame: Frame<Bytes>, bytes: u64, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<Bytes>, Error>>>

Hands out frame once bytes of it are charged, buffering the frame while the acquisition is pending.

Trait Implementations

impl Body for AccountedBody

type Data = Bytes

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

fn poll_frame( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>>

Attempt to pull out the next data buffer of this stream.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.