axum-extra SpaRouter support include_dir!

[Sherlock-Holo]

• I have looked for existing issues (including closed) about this

Feature Request

Motivation

when using SpaRouter, it needs a real dir in the fs, however, sometimes the resources may include in the binary by something like include_dir!.

If SpaRouter allows using a virtual dir to access the resources, it will increase the practical

Proposal

maybe SpaRouter can provide a trait like

trait VirtualDir {
    type VirtualFile: AsyncRead + AsyncWrite + AsyncSeek + Unpin + Send + 'static;
    type VirtualFilenameStream: Stream<Item=io::Result<PathBuf>> + Unpin + Send + 'static;


    async fn open_file(&self, name: &str) -> io::Result<Self::VirtualFile>;

    async fn list_files(&self, dir: &str) -> io::Result<Self::VirtualFilenameStream>;
}

to allow user pass a virtual dir to the SpaRouter

Alternatives

user can also try to write the file data to a tmp dir and let SpaRouter access them, but I don't think this way is a good idea

[davidpdrsn]

This is something we're already working on in tower-http. See tower-rs/tower-http#309 and tower-rs/tower-http#313.

How exactly that'll be integrated into SpaRouter is unclear but until its landed in tower-http there isn't much we can do.

I'm actually considering removing SpaRouter all together since ServeDir is soon gonna be easier to use (thanks to tower-rs/tower-http#283). It is also more flexible (see https://github.com/tokio-rs/axum/blob/main/examples/static-file-server/src/main.rs). But thats a separate discussion of course. Though I think I'll close this issue for now. Feel free to ask follow up questions though :)

[gko]

made a small POC with include_dir https://dev.to/konstantin/bundle-frontend-with-axum-build-using-includedir-g8i