Skip to main content

RouteBuilder

Struct RouteBuilder 

Source
pub struct RouteBuilder<S> { /* private fields */ }
Expand description

Builder for configuring routes and settings before creating an App.

RouteBuilder uses a fluent API to register routes, configure CORS, and adjust server settings. Call .seal() to produce the final App<S>.

§Example

use mini_serve::{RouteBuilder, handler, body};
use hyper::Response;
use hyper::body::Bytes;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let app = RouteBuilder::stateless()
        .get("/health", handler(|_, _| async {
            Ok(Response::new(body(Bytes::from("OK"))))
        }))
        .seal();

    app.bind("127.0.0.1:8080".parse()?).await?;
    Ok(())
}

Implementations§

Source§

impl<S: Send + Sync + 'static> RouteBuilder<S>

Source

pub fn new(state: S) -> Self

Create a new builder with shared state.

Source

pub fn with_max_body_size(self, max: usize) -> Self

Set the maximum request body size in bytes (default: 2 MiB).

Source

pub fn with_header_read_timeout(self, d: Duration) -> Self

Set the header read timeout (default: 30 seconds).

Source

pub fn with_max_connections(self, max: usize) -> Self

Set the maximum concurrent connections (default: 1024).

Source

pub fn with_error_handler( self, f: impl Fn(StatusCode, &str) -> Response<ResponseBody> + Send + Sync + 'static, ) -> Self

Source

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

Source

pub fn get(self, path: &str, handler: Handler<S>) -> Self

Source

pub fn post(self, path: &str, handler: Handler<S>) -> Self

Source

pub fn put(self, path: &str, handler: Handler<S>) -> Self

Source

pub fn delete(self, path: &str, handler: Handler<S>) -> Self

Source

pub fn seal(self) -> App<S>

Source§

impl RouteBuilder<()>

Source

pub fn stateless() -> Self

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for RouteBuilder<S>

§

impl<S> !UnwindSafe for RouteBuilder<S>

§

impl<S> Freeze for RouteBuilder<S>

§

impl<S> Send for RouteBuilder<S>
where S: Sync + Send,

§

impl<S> Sync for RouteBuilder<S>
where S: Sync + Send,

§

impl<S> Unpin for RouteBuilder<S>

§

impl<S> UnsafeUnpin for RouteBuilder<S>

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