Struct Router 

pub struct Router { /* private fields */ }

Implementations

impl Router

pub fn new() -> Self

pub fn with_state<T: Clone + Send + Sync + 'static>(&mut self, state: T)

Add a shared state to the router that will be available in all handlers

pub fn get<H, Args>(&mut self, path: &str, handler: H)

where H: Handler<Args>, Args: Send + Sync + 'static,

pub fn post<H, Args>(&mut self, path: &str, handler: H)

where H: Handler<Args>, Args: Send + Sync + 'static,

pub fn put<H, Args>(&mut self, path: &str, handler: H)

where H: Handler<Args>, Args: Send + Sync + 'static,

pub fn delete<H, Args>(&mut self, path: &str, handler: H)

where H: Handler<Args>, Args: Send + Sync + 'static,

pub fn patch<H, Args>(&mut self, path: &str, handler: H)

where H: Handler<Args>, Args: Send + Sync + 'static,

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

where L: Layer<EndpointService> + Send + Sync + 'static, L::Service: Endpoint,

Add a middleware layer to all routes in the router.

The layer must implement tower::Layer<EndpointService> and return a new Endpoint.

Limitations

Body-type-changing middleware (like CorsLayer and CompressionLayer from tower-http) cannot be used with this method. These middleware change the HTTP response body type, which is incompatible with the Endpoint trait that expects OxiditeResponse.

For such middleware, use ServiceBuilder instead:

let service = ServiceBuilder::new()
    .layer(CorsLayer::permissive())
    .layer(CompressionLayer::new())
    .service(router);

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

where L: Layer<EndpointService> + Send + Sync + 'static, L::Service: Endpoint,

Alias for .layer().

pub fn with_cors(self, config: CorsConfig) -> Self

Configure CORS for this router.

This adds CORS headers to all responses, including preflight OPTIONS requests. This is a framework-level CORS implementation that doesn’t require tower-http.

Example

use oxidite::prelude::*;

let router = Router::new()
    .with_cors(CorsConfig {
        allowed_origins: vec!["http://localhost:3000".to_string()],
        allowed_methods: vec!["GET".to_string(), "POST".to_string()],
        allowed_headers: vec!["Content-Type".to_string(), "Authorization".to_string()],
        allow_credentials: true,
        max_age: 3600,
    });

For development, you can use the permissive config:

let router = Router::new()
    .with_cors(CorsConfig::permissive());

pub async fn handle(&self, req: OxiditeRequest) -> Result<OxiditeResponse>

Trait Implementations

impl Clone for Router

fn clone(&self) -> Router

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Router

fn default() -> Self

Returns the “default value” for a type.

impl Service<Request<BoxBody<Bytes, Error>>> for Router

type Response = OxiditeResponse

Responses given by the service.

type Error = Error

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<Router as Service<Request<BoxBody<Bytes, Error>>>>::Response, Error>> + Send>>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: OxiditeRequest) -> Self::Future

Process the request and return the response asynchronously.