Body

rama::http::core::body

Struct Body

pub struct Body(/* private fields */);

Expand description

The body type used in rama requests and responses.

Implementations§

impl Body

pub fn new<B>(body: B) -> Body
where B: Body<Data = Bytes> + Send + Sync + 'static, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>,

Create a new Body that wraps another Body.

pub fn with_limit<B>(body: B, limit: usize) -> Body
where B: Body<Data = Bytes> + Send + Sync + 'static, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>,

Create a new Body with a maximum size limit.

pub fn empty() -> Body

Create an empty body.

pub fn from_stream<S>(stream: S) -> Body
where S: TryStream + Send + 'static, <S as TryStream>::Ok: Into<Bytes>, <S as TryStream>::Error: Into<Box<dyn Error + Sync + Send>>,

Create a new Body from a Stream.

pub fn limited(self, limit: usize) -> Body

Create a new Body from a Stream with a maximum size limit.

pub fn into_data_stream(self) -> BodyDataStream

Convert the body into a Stream of data frames.

Non-data frames (such as trailers) will be discarded. Use http_body_util::BodyStream if you need a Stream of all frame types.

pub fn into_event_stream<T>(self) -> EventStream<BodyDataStream, T>
where T: EventDataRead,

Convert the body into a Stream of sse::Events.

https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events.

pub fn into_json_stream<T>(self) -> JsonReadStream<T, BodyDataStream>
where T: DeserializeOwned,

Convert the body into a [JsonStream].

Stream of json objects, each object separated by a newline (\n).

pub fn into_json_stream_with_config<T>( self, cfg: ParseConfig, ) -> JsonReadStream<T, BodyDataStream>
where T: DeserializeOwned,

Convert the body into a [JsonStream].

Stream of json objects, each object separated by a newline (\n).

pub fn into_string_data_event_stream(self) -> EventStream<BodyDataStream>

Convert the body into a Stream of sse::Events with optional string data.

https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events.

pub async fn chunk( &mut self, ) -> Result<Option<Bytes>, Box<dyn Error + Sync + Send>>

Stream a chunk of the response body.

When the response body has been exhausted, this will return None.

Trait Implementations§

impl Debug for Body

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

Formats the value using the given formatter. Read more

impl Default for Body

fn default() -> Body

Returns the “default value” for a type. Read more

impl From<&'static [u8]> for Body

fn from(buf: &'static [u8]) -> Body

Converts to this type from the input type.

impl From<&'static str> for Body

fn from(buf: &'static str) -> Body

Converts to this type from the input type.

impl From<()> for Body

fn from(_: ()) -> Body

Converts to this type from the input type.

impl From<Bytes> for Body

fn from(buf: Bytes) -> Body

Converts to this type from the input type.

impl From<Cow<'static, [u8]>> for Body

fn from(buf: Cow<'static, [u8]>) -> Body

Converts to this type from the input type.

impl From<Cow<'static, str>> for Body

fn from(buf: Cow<'static, str>) -> Body

Converts to this type from the input type.

impl From<InfiniteReader> for Body

fn from(reader: InfiniteReader) -> Body

Converts to this type from the input type.

impl From<RetryBody> for Body

fn from(body: RetryBody) -> Body

Converts to this type from the input type.

impl From<String> for Body

fn from(buf: String) -> Body

Converts to this type from the input type.

impl From<Vec<u8>> for Body

fn from(buf: Vec<u8>) -> Body

Converts to this type from the input type.

impl From<ZipBomb> for Body

fn from(value: ZipBomb) -> Body

Converts to this type from the input type.

impl IntoResponse for Body

fn into_response(self) -> Response

Create a response.

impl Body for Body

type Data = Bytes

Values yielded by the Body.

type Error = OpaqueError

The error type this Body might generate.

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

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

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream. Read more

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached. Read more

impl<T> TryFrom<Csv<T>> for Body
where T: IntoIterator, <T as IntoIterator>::Item: Serialize,

type Error = OpaqueError

The type returned in the event of a conversion error.

fn try_from(csv: Csv<T>) -> Result<Body, <Body as TryFrom<Csv<T>>>::Error>

Performs the conversion.

impl<T> TryFrom<Form<T>> for Body
where T: Serialize,

type Error = OpaqueError

The type returned in the event of a conversion error.

fn try_from(form: Form<T>) -> Result<Body, <Body as TryFrom<Form<T>>>::Error>

Performs the conversion.

impl<T> TryFrom<Json<T>> for Body
where T: Serialize,

type Error = OpaqueError

The type returned in the event of a conversion error.

fn try_from(json: Json<T>) -> Result<Body, <Body as TryFrom<Json<T>>>::Error>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for Body

impl !RefUnwindSafe for Body

impl Send for Body

impl Sync for Body

impl Unpin for Body

impl !UnwindSafe for Body

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

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

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

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

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

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

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

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.

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.

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

Turn this body into a boxed trait object.

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.

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

Turn this body into Collected body which will collect all the DATA frames and trailers.

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

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

Turn this body into BodyDataStream.

impl<B> BodyExtractExt for B
where B: Into<Body> + Send + 'static,

async fn try_into_json<T>(self) -> Result<T, OpaqueError>
where T: DeserializeOwned + Send + 'static,

Try to deserialize the (contained) body as a JSON object.

async fn try_into_string(self) -> Result<String, OpaqueError>

Try to turn the (contained) body in an utf-8 string.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

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

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

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

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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

fn rama_from(value: T) -> U

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

fn rama_into(self) -> U

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

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

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

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

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

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

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

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