Struct actix_web_lab::web::Spa

pub struct Spa { /* private fields */ }

Available on crate feature spa only.

Single Page App (SPA) service builder.

Examples

let app = App::new()
    // ...api routes...
    .service(
        spa()
            .index_file("./examples/assets/spa.html")
            .static_resources_mount("/static")
            .static_resources_location("./examples/assets")
            .finish()
    );

Implementations

impl Spa

pub fn index_file(self, index_file: impl Into<Cow<'static, str>>) -> Self

Location of the SPA index file.

This file will be served if:

• the Actix Web router has reached this service, indicating that none of the API routes matched the URL path;
• and none of the static resources handled matched.

The default is “./index.html”. I.e., the index.html file located in the directory that the server is running from.

pub fn static_resources_mount(
    self,
    static_resources_mount: impl Into<Cow<'static, str>>
) -> Self

The URL path prefix that static files should be served from.

The default is “/”. I.e., static files are served from the root URL path.

pub fn static_resources_location(
    self,
    static_resources_location: impl Into<Cow<'static, str>>
) -> Self

The location in the filesystem to serve static resources from.

The default is “./”. I.e., static files are located in the directory the server is running from.

pub fn finish(self) -> impl HttpServiceFactory

Constructs the service for use in a .service() call.

Trait Implementations

impl Clone for Spa

fn clone(&self) -> Spa

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Spa

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Spa

fn default() -> Self

Returns the “default value” for a type.