Skip to main content

Payload

Struct Payload 

Source
pub struct Payload<S, E>
where S: Stream<Item = Result<Bytes, E>> + Unpin, E: Into<Box<dyn StdErr + Send + Sync>>,
{ pub expected_size: u64, pub stream: S, }
Expand description

A bundle that ties together a raw byte stream and its declared size.

This newtype exists to avoid “primitive obsession” — passing expected_size and stream as separate parameters to multiple layers of functions is error-prone. Bundling them enforces that the two always travel together.

The expected_size is used to pre-allocate disk space via fallocate before streaming begins, which improves performance on spinning drives and SD cards by preventing filesystem fragmentation.

Fields§

§expected_size: u64

The total number of bytes the client claims it will send. This is trusted for pre-allocation but validated at EOF.

§stream: S

The raw async stream of byte chunks from the request body.

Implementations§

Source§

impl<S, E> Payload<S, E>
where S: Stream<Item = Result<Bytes, E>> + Unpin, E: Into<Box<dyn StdErr + Send + Sync>>,

Source

pub fn new<T>(expected_size: T, stream: S) -> Self
where T: Into<u64>,

Constructs a new Payload from an expected size and an async byte stream.

The expected_size accepts any type that can be converted to u64, so passing a u32 or usize directly is fine.

Auto Trait Implementations§

§

impl<S, E> Freeze for Payload<S, E>
where S: Freeze,

§

impl<S, E> RefUnwindSafe for Payload<S, E>
where S: RefUnwindSafe,

§

impl<S, E> Send for Payload<S, E>
where S: Send,

§

impl<S, E> Sync for Payload<S, E>
where S: Sync,

§

impl<S, E> Unpin for Payload<S, E>

§

impl<S, E> UnsafeUnpin for Payload<S, E>
where S: UnsafeUnpin,

§

impl<S, E> UnwindSafe for Payload<S, E>
where S: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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
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
§

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
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 = Infallible

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

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

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.
§

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