Skip to main content

CaptureBody

rama_http_types::body

Struct CaptureBody 

Source 
pub struct CaptureBody<B, S>
where
    B: StreamingBody<Data = Bytes>,
    S: BodyCaptureSink,
{ /* private fields */ }
Expand description

A body that asynchronously sends an owned copy of each frame to a sink.

At most one original frame and its reference-counted capture copy are retained while the sink future is pending. No whole-body buffering or internal channel is used.

Implementations§

Source§

impl<B, S> CaptureBody<B, S>
where B: StreamingBody<Data = Bytes>, S: BodyCaptureSink,

Source

pub fn new(inner: B, sink: S) -> Self

Wrap a body with an asynchronous capture sink.

Source

pub const fn get_ref(&self) -> &B

Return a reference to the wrapped body.

Source

pub fn get_mut(&mut self) -> &mut B

Return a mutable reference to the wrapped body.

Source

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut B>

Return a pinned mutable reference to the wrapped body.

Source

pub fn into_inner(self) -> B

Consume the wrapper and return the inner body.

The sink receives BodyCaptureSink::aborted.

Source§

impl<B> CaptureBody<B, BufferedBodyCapture>
where B: StreamingBody<Data = Bytes>,

Source

pub fn buffered(inner: B, limit: CaptureLimit) -> (Self, CaptureHandle)

Wrap a body and retain a bounded or unlimited copy in memory.

Trait Implementations§

Source§

impl<B, S> Body for CaptureBody<B, S>
where B: StreamingBody<Data = Bytes>, S: BodyCaptureSink,

Source§

type Data = Bytes

Values yielded by the Body.
Source§

type Error = <B as Body>::Error

The error type this Body might generate.
Source§

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

Attempt to pull out the next frame of this stream. Read more
Source§

fn is_end_stream(&self) -> bool

A hint that may return true when the end of stream has been reached. Read more
Source§

fn size_hint(&self) -> SizeHint

A hint that returns the bounds on the remaining length of the stream. Read more
Source§

impl<B, S> Debug for CaptureBody<B, S>
where B: StreamingBody<Data = Bytes> + Debug, S: BodyCaptureSink,

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'__pin, B, S> Unpin for CaptureBody<B, S>
where PinnedFieldsOf<__Origin<'__pin, B, S>>: Unpin, B: StreamingBody<Data = Bytes>, S: BodyCaptureSink,

Auto Trait Implementations§

§

impl<B, S> !Freeze for CaptureBody<B, S>

§

impl<B, S> !RefUnwindSafe for CaptureBody<B, S>

§

impl<B, S> !UnwindSafe for CaptureBody<B, S>

§

impl<B, S> Send for CaptureBody<B, S>
where B: Send, CaptureGuard<S>: Send, Option<PendingOutput<<B as Body>::Error>>: Send,

§

impl<B, S> Sync for CaptureBody<B, S>
where B: Sync, CaptureGuard<S>: Sync, Option<PendingOutput<<B as Body>::Error>>: Sync,

§

impl<B, S> UnsafeUnpin for CaptureBody<B, S>
where B: UnsafeUnpin, CaptureGuard<S>: UnsafeUnpin, Option<PendingOutput<<B as Body>::Error>>: UnsafeUnpin,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> BodyExt for T
where T: Body + ?Sized,

Source§

fn frame(&mut self) -> Frame<'_, Self> ⓘ
where Self: Unpin,

Returns a future that resolves to the next Frame, if any.
Source§

fn map_frame<F, B>(self, f: F) -> MapFrame<Self, F>
where Self: Sized, F: FnMut(Frame<Self::Data>) -> Frame<B>, B: Buf,

Maps this body’s frame to a different kind.
Source§

fn inspect_frame<F>(self, f: F) -> InspectFrame<Self, F>
where Self: Sized, F: FnMut(&Frame<Self::Data>),

A body that calls a function with a reference to each frame before yielding it.
Source§

fn capture<S>(self, sink: S) -> CaptureBody<Self, S>
where Self: Sized + Body<Data = Bytes>, S: BodyCaptureSink,

Forward this byte body while asynchronously sending owned frame copies to a sink.
Source§

fn capture_buffered( self, limit: CaptureLimit, ) -> (CaptureBody<Self, BufferedBodyCapture>, CaptureHandle)
where Self: Sized + Body<Data = Bytes>,

Forward this byte body while retaining a bounded or unlimited copy in memory.
Source§

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>
where Self: Sized, F: FnMut(Self::Error) -> E,

Maps this body’s error value to a different value.
Source§

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>
where Self: Sized, F: FnMut(&Self::Error),

A body that calls a function with a reference to an error before yielding it.
Source§

fn boxed(self) -> BoxBody<Self::Data, Self::Error>
where Self: Sized + Send + Sync + 'static,

Turn this body into a boxed trait object.
Source§

fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>
where Self: Sized + Send + 'static,

Turn this body into a boxed trait object that is !Sync.
Source§

fn collect(self) -> Collect<Self> ⓘ
where Self: Sized,

Turn this body into Collected body which will collect all the DATA frames and trailers. Read more
Source§

fn collect_with(self, opts: CollectOptions) -> CollectWith<Self> ⓘ
where Self: Sized + Body<Data = Bytes, Error: Into<BoxError>> + Send + Sync + Unpin + 'static,

Collect this body, but bounded by the size cap and/or timeout in CollectOptions. Read more
Source§

fn with_trailers<F>(self, trailers: F) -> WithTrailers<Self, F>
where Self: Sized, F: Future<Output = Option<Result<HeaderMap, Self::Error>>>,

Add trailers to the body. Read more
Source§

fn into_data_stream(self) -> BodyDataStream<Self>
where Self: Sized,

Turn this body into BodyDataStream.
Source§

fn into_stream(self) -> BodyStream<Self>
where Self: Sized,

Turn this body into BodyStream. Read more
Source§

fn fuse(self) -> Fuse<Self>
where Self: Sized,

Creates a fused body. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn rama_from(value: T) -> U

Source§

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

Source§

fn rama_into(self) -> U

Source§

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

Source§

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

Source§

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

Source§

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

Source§

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

Source§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more