RapidServer

Struct RapidServer 

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

Fields§

§port: Option<u16>§hostname: Option<String>

Implementations§

Source§

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
Source

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

Source

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 using the RapidServer::fs_router function

Source

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…

Source

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)

§Notes

This function will try to initalize a logger in case one has not already been initalized. If you would like to use your own logger, make sure it has been initalized before this function is called

Trait Implementations§

Source§

impl Clone for RapidServer

Source§

fn clone(&self) -> RapidServer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,