一般网页浏览器在打开一些常用文档、图片、视频等格式时,会直接在网页浏览器上进行浏览或是播放,但有时候我们会希望用户可以在点击网页链接之后,无论该链接的资源是什么类型的文件,使网页浏览器都会跳出下载的窗口。

Download Response for Rocket Framework

「Download Response for Rocket Framework」是笔者开发的套件,可以使 Rocket 框架直接回应一个 Vec<u8> 实体、一个 Reader 或是一个文件,并且可以让网页浏览器在链接的时候直接跳出下载窗口。

Crates.io

Cargo.toml

rocket-download-response = "*"

使用方法

rocket_download_response 这个 crate 提供的 DownloadResponse 结构体可以当作要回应的数据类型。DownloadResponse 结构体提供了 from_slice 关联函数和 from_vec 关联函数,可以从参数中传入要拿来回应的 &'static [u8] 参考或 Vec<u8> 实体、文件类型和下载时预设的文件名称(如果不设置文件名称的话,网页浏览器会用网址路径的文件名称来当作文件名称)。它也提供了 from_reader 关联函数,可以从参数中传入任意有实作 Read 特性的实体、文件类型和下载时预设的文件名称。

如果数据源为文件的话,那就更方便了,可以直接使用 DownloadResponse 结构体提供的 from_file 关联函数,可以从参数中传入文件路径、文件类型和下载时预设的文件名称。如果不提供文件类型的话,预设会由文件路径中的扩展名来判断;如果不提供文件名称的话,预设会由文件路径中的文件名称来判断;如果想要直接使用网址路径的文件名称作为预设的文件名称的话,那就把文件名称设置为空字符串。

举个例子,假设工作目录中有 examples/images/image.jpg 这张 JPEG 图档。若想要让 Rocket 框架提供这个图档,并且让网页浏览器不直接浏览这个图档,而是将其下载到文件系统的话,程序可以这样写:

#[macro_use]
extern crate rocket;

use std::io::ErrorKind;
use std::path::Path;

use rocket::http::Status;

use rocket_download_response::DownloadResponse;

#[get("/")]
async fn download() -> Result<DownloadResponse, Status> {
    let path = Path::join(Path::new("examples"), Path::join(Path::new("images"), "image.jpg"));

    DownloadResponse::from_file(path, None::<String>, None).await.map_err(|err| {
        if err.kind() == ErrorKind::NotFound {
            Status::NotFound
        } else {
            Status::InternalServerError
        }
    })
}

#[launch]
fn rocket() -> _ {
    rocket::build().mount("/", routes![download])
}