Struct RootHandlerBuilder

pub struct RootHandlerBuilder<S = RouterService> { /* private fields */ }

A helper struct to build the root handler for the project.

This is mainly useful for attaching middlewares to the project.

Examples

use cot::middleware::LiveReloadMiddleware;
use cot::project::{MiddlewareContext, RootHandlerBuilder};
use cot::{BoxedHandler, Project, ProjectContext};

struct MyProject;
impl Project for MyProject {
    fn middlewares(
        &self,
        handler: RootHandlerBuilder,
        context: &MiddlewareContext,
    ) -> BoxedHandler {
        handler
            .middleware(LiveReloadMiddleware::from_context(context))
            .build()
    }
}

Implementations

impl<S> RootHandlerBuilder<S>

where S: Service<Request, Response = Response, Error = Error> + Send + Sync + Clone + 'static, S::Future: Send,

pub fn middleware<M>( self, middleware: M, ) -> RootHandlerBuilder<IntoCotError<IntoCotResponse<<M as Layer<S>>::Service>>>

where M: Layer<S>,

Adds middleware to the project.

This method is used to add middleware to the project. The middleware will be applied to all routes in the project.

Examples

use cot::middleware::LiveReloadMiddleware;
use cot::project::{MiddlewareContext, RootHandlerBuilder};
use cot::{BoxedHandler, Project, ProjectContext};

struct MyProject;
impl Project for MyProject {
    fn middlewares(
        &self,
        handler: RootHandlerBuilder,
        context: &MiddlewareContext,
    ) -> BoxedHandler {
        handler
            .middleware(LiveReloadMiddleware::from_context(context))
            .build()
    }
}

pub fn build(self) -> BoxedHandler

Builds the root handler for the project.

Examples

use cot::middleware::LiveReloadMiddleware;
use cot::project::{MiddlewareContext, RootHandlerBuilder};
use cot::{BoxedHandler, Project, ProjectContext};

struct MyProject;
impl Project for MyProject {
    fn middlewares(
        &self,
        handler: RootHandlerBuilder,
        context: &MiddlewareContext,
    ) -> BoxedHandler {
        handler
            .middleware(LiveReloadMiddleware::from_context(context))
            .build()
    }
}

Trait Implementations

impl<S: Clone> Clone for RootHandlerBuilder<S>

fn clone(&self) -> RootHandlerBuilder<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for RootHandlerBuilder<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S: Hash> Hash for RootHandlerBuilder<S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<S: PartialEq> PartialEq for RootHandlerBuilder<S>

fn eq(&self, other: &RootHandlerBuilder<S>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: Eq> Eq for RootHandlerBuilder<S>

impl<S> StructuralPartialEq for RootHandlerBuilder<S>