Skip to main content

Upload

Struct Upload 

Source
pub struct Upload {
    pub bytes: Vec<u8>,
    pub content_type: String,
}
Available on crate feature http only.
Expand description

A raw request body — an uploaded file, rather than a JSON:API document.

The counterpart of Download on the way in. Use it as a resource’s Create input when the body is the file:

ⓘ
impl Resource<App> for Doc {
    type Create = Upload;
    type Update = Upload;
    // …
}

impl Create<Doc> for App {
    async fn create(&self, input: Upload, ctx: &Context) -> Result<Doc, Self::Error> {
        Ok(self.store(input.content_type, input.bytes))
    }
}

§Limits

The default cap is MAX_UPLOAD, not MAX_BODY: a file is expected to be larger than a document. Both exist because an unbounded read is a denial of service written in one line — a client that can make the server buffer without limit does not need any other exploit.

Raise or lower it per resource with Upload::limited, and restrict what may be sent with Upload::accepting.

Fields§

§bytes: Vec<u8>

The bytes, as sent.

§content_type: String

The Content-Type the client declared.

Taken at the client’s word and never sniffed — but see Upload::accepting, and note that Download sends nosniff so a lie here cannot become active content in your origin.

Implementations§

Source§

impl Upload

Source

pub async fn limited( request: Request, ctx: &Context, limit: usize, ) -> Result<Self, Errors>

Read a request body as an upload, capped at limit bytes.

The building block behind the FromRequest impl; call it directly from your own impl to use a different limit:

ⓘ
impl FromRequest<App> for Avatar {
    async fn from_request(req: Request, _s: &App, ctx: &Context) -> Result<Self, Errors> {
        let upload = Upload::limited(req, ctx, 256 * 1024).await?;
        Ok(Avatar(upload))
    }
}
Source

pub async fn accepting( request: Request, ctx: &Context, limit: usize, accepted: &[&str], ) -> Result<Self, Errors>

Read an upload, refusing a media type not in accepted.

The check a file endpoint should not be without: an avatar route that accepts text/html is a stored-XSS vector waiting for someone to serve it back inline. Compared against the type alone, so image/png; charset=… still matches image/png.

Source

pub fn len(&self) -> usize

How many bytes were uploaded.

Source

pub fn is_empty(&self) -> bool

Whether the body was empty.

Trait Implementations§

Source§

impl Clone for Upload

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Upload

Source§

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

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

impl<S: Sync> FromRequest<S> for Upload

Reads any request body as an upload, capped at MAX_UPLOAD.

Deliberately does not check the media type — an upload is not a JSON:API document, so the JSON:API media-type check would reject every real file. Use Upload::accepting from your own impl when the endpoint should only take certain types.

Source§

async fn from_request( request: Request, _state: &S, ctx: &Context, ) -> Result<Self, Errors>

Read the request into Self. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<B> FromRef<B> for B
where B: Clone,

Source§

fn from_ref(backend: &B) -> B

Extract a Self from a reference to the composite backend B.
Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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