Skip to main content

HoochAppBuilder

Struct HoochAppBuilder 

Source
pub struct HoochAppBuilder { /* private fields */ }
Expand description

Builder for configuring and creating a HoochApp instance.

The builder collects middleware and routes, then consumes itself to create a static instance of the application. Note that middleware and routes are leaked to achieve a 'static lifetime.

Implementations§

Source§

impl HoochAppBuilder

Source

pub fn new(addr: impl ToSocketAddrs) -> Result<Self>

Creates a new HoochAppBuilder from an address that implements ToSocketAddrs.

§Errors

Returns an error if the provided address cannot be resolved.

Source

pub fn add_middleware<Fut, F>(&mut self, middleware: F)
where Fut: Future<Output = Middleware> + Send + 'static, F: Fn(HttpRequest<'static>, SocketAddr) -> Fut + Send + Sync + 'static,

Adds a middleware function to the application.

The middleware is a function that receives an HTTP request and the client’s socket address, and returns a [MiddlewareFuture] indicating whether to continue processing or short-circuit.

Source

pub fn add_route<FutRoute, FnRoute>( &mut self, path: &'static str, method: HttpMethod, route: FnRoute, )
where FnRoute: Fn(HttpRequest<'static>, Params<'static>) -> FutRoute + Sync + Send + 'static, FutRoute: Future<Output = HttpResponse> + Send + 'static,

Adds a new route to the application.

The route is specified by a URI pattern, an HTTP method, and a handler function. The handler receives the request and extracted route parameters, and returns a [RouterFuture].

Source

pub fn build(self) -> HoochApp

Consumes the builder and returns a HoochApp instance.

This function leaks the middleware and route vectors in order to provide them with a 'static lifetime, which is required by the async runtime.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.