Struct SpaServer 

pub struct SpaServer<T = ()>
where
    T: Clone + Send + Sync + 'static,
{ /* private fields */ }

A server wrapped axum server.

It can:

• serve static files in SPA root path
• serve API requests in router
• fallback to SPA static file when route matching failed
  • if still get 404, it will redirect to SPA index.html

Implementations

impl<T> SpaServer<T>

where T: Clone + Send + Sync + 'static,

pub fn new() -> Result<Self>

Just new(), nothing special

pub fn data(self, data: T) -> Self

where T: Clone + Send + Sync + 'static,

Specific server context data

This is similar to axum middleware

pub fn layer<L, NewResBody>(self, layer: L) -> Self

where L: Layer<Route> + Clone + Send + 'static, L::Service: Service<Request, Response = Response<NewResBody>, Error = Infallible> + Clone + Send + 'static, <L::Service as Service<Request>>::Future: Send + 'static, NewResBody: HttpBody<Data = Bytes> + Send + 'static, NewResBody::Error: Into<BoxError>,

Specific an axum layer to server

This is similar to axum middleware

pub fn release_path(self, rp: impl Into<PathBuf>) -> Self

static file release path in runtime

Default path is /tmp/[env!(CARGO_PKG_NAME)]_static_files

pub async fn run<Root>(self, root: Root) -> Result<()>

where Root: SpaStatic,

Run the spa server forever

pub async fn run_api(self) -> Result<()>

Run the spa server without spa root

pub fn route(self, path: impl AsRef<str>, router: Router) -> Self

Setting up server router, see example for usage.

pub fn port(self, port: u16) -> Self

Server listening port, default is 8080

pub fn static_path( self, path: impl Into<String>, dir: impl Into<PathBuf>, ) -> Self

Setting up a runtime static file path.

Unlike spa_server_root, file in this path can be changed in runtime.

pub fn host_router(self, host: impl Into<String>, router: Router) -> Self

add host based router

Trait Implementations

impl<T> Default for SpaServer<T>

where T: Clone + Send + Sync + 'static + Default,

fn default() -> SpaServer<T>

Returns the “default value” for a type.