Struct rapid_web::server::RapidServer

pub struct RapidServer {
    pub port: Option<u16>,
    pub hostname: Option<String>,
}

Fields

port: Option<u16>

hostname: Option<String>

Implementations

impl RapidServer

A custom actix-web server implementation for the Rapid Framework

Examples

use rapid_web::server::RapidServer;

let app = RapidServer::create(None, None, None, None);

app.listen(HttpServer::new(move || {
	RapidServer::router(None).route("/", web::get().to(route))
})).await

pub fn create(port: Option<u16>, hostname: Option<String>) -> Self

pub fn router( cors: Option<Cors>, log_type: Option<RapidLogger> ) -> App<impl ServiceFactory<ServiceRequest, Response = ServiceResponse<impl MessageBody>, Config = (), InitError = (), Error = Error>>

A stock re-export of the actix-web “App::new()” router with a few extras This router does not support type-safe file based routing Note: to experience the full capabilities of rapid-web, we recommend useing the RapidServer::fs_router function

pub fn fs_router( cors: Option<Cors>, log_type: Option<RapidLogger>, routes: Scope ) -> App<impl ServiceFactory<ServiceRequest, Response = ServiceResponse<impl MessageBody>, Config = (), InitError = (), Error = Error>>

A file-system based router for rapid-web

Build your api with a simple file based technique (ex: _middleware.rs, index.rs)

• routes - A string slice that holds the path to the file system routes root directory (ex: “src/routes”) – this value can be anything as long as it is a valid (relative) directory path
• cors - An optional cors value that can be used to configure the cors middleware
• log_type - An optional logger type that can be used to configure the logger middleware used for every request/response

Docs coming soon…

pub async fn listen<F, I, S, B>( self, server: HttpServer<F, I, S, B> ) -> Result<()>where F: Fn() -> I + Send + Clone + 'static, I: IntoServiceFactory<S, Request>, S: ServiceFactory<Request, Config = AppConfig> + 'static, S::Error: Into<Error>, S::InitError: Debug, S::Response: Into<Response<B>>, B: MessageBody + 'static,

Takes in a pre-configured HttpServer and listens on the specified port(s)

Trait Implementations

impl Clone for RapidServer

fn clone(&self) -> RapidServer

Returns a copy of the value.

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

Performs copy-assignment from source.