Struct Download 

pub struct Download { /* private fields */ }

Files sent as downloads: bytes made in the handler (a PDF, a CSV), a file on disk (streamed), a key in Storage, or any stream.

use renox::Download;

async fn invoice(State(state): State<AppState>, Path(id): Path<i64>) -> Result<Download> {
    let pdf: Vec<u8> = b"%PDF-1.7 ...".to_vec(); // made by your PDF library
    Ok(Download::bytes(format!("invoice-{id}.pdf"), "application/pdf", pdf).inline())
}

async fn export(State(state): State<AppState>) -> Result<Download> {
    Download::from_storage(&state.storage, "exports/sales.csv", "sales.csv").await
}

async fn backup() -> Result<Download> {
    Download::file("storage/backup.db", "backup.db").await // streamed, not read into memory
}

Implementations

impl Download

pub fn bytes( filename: impl Into<String>, content_type: impl Into<String>, data: impl Into<Bytes>, ) -> Self

data as a file named filename.

pub async fn file( path: impl AsRef<Path>, filename: impl Into<String>, ) -> Result<Self>

A file on disk, streamed; its type comes from its extension. A missing file is a 404.

pub async fn from_storage( storage: &Storage, key: &str, filename: impl Into<String>, ) -> Result<Self>

A file in Storage (local disk or S3). A missing key is a 404.

pub fn stream<S, E>( filename: impl Into<String>, content_type: impl Into<String>, stream: S, ) -> Self

where S: Stream<Item = Result<Bytes, E>> + Send + 'static, E: Into<BoxError>,

Any stream of bytes, e.g. a CSV written row by row as the database hands them over.

pub fn inline(self) -> Self

Shown in the browser (a PDF, an image) instead of saved. HTML, XML and JavaScript are always downloads, so a file can’t run as a page of the app.

Trait Implementations

impl IntoResponse for Download

fn into_response(self) -> Response

Create a response.