Skip to main content

Download

Struct Download 

Source
pub struct Download { /* private fields */ }
Available on crate feature http only.
Expand description

Raw bytes, with their own media type — a file, not a document.

The one response in this crate that is deliberately not application/vnd.api+json. A resource’s bytes are not a JSON:API document and wrapping them in one would mean base64 in an attribute, which doubles the transfer and cannot be streamed or ranged.

The conventional shape, and the one CONTENT routes: the resource stays a JSON document carrying metadata at /docs/{id}, and its bytes live beside it at /docs/{id}/content.

use ash_jsonapi::response::Download;

let file = Download::new(vec![0x89, b'P', b'N', b'G'], "image/png")
    .filename("diagram.png");

Implementations§

Source§

impl Download

Source

pub fn new(bytes: impl Into<Vec<u8>>, content_type: impl Into<String>) -> Self

Bytes, and the media type to serve them as.

The media type is the caller’s: this crate does not sniff content, because guessing a type from bytes is how an uploaded HTML file comes back as text/html and runs as the origin.

Source

pub fn filename(self, filename: impl Into<String>) -> Self

Suggest a filename, and ask the browser to save rather than render.

Sets Content-Disposition: attachment. The name is escaped — see disposition.

Source

pub fn inline(self) -> Self

Render in the browser rather than downloading, keeping any filename.

Content-Disposition: inline — for an image or a PDF a user expects to see rather than save. Off by default: attachment is the safer choice, since it does not invite the browser to interpret the bytes.

Trait Implementations§

Source§

impl IntoResponse for Download

Source§

fn into_response(self) -> Response

Create a response.

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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