Struct RouterBuilder

Source
pub struct RouterBuilder<State, E>
where E: RoutableHttpEvent, State: Send + Sync + Clone + 'static,
{ /* private fields */ }
Expand description

A builder for constructing routers with a fluent API.

This type provides a more ergonomic way to create and configure routers compared to using Router directly. It supports method chaining and handles all the type complexity internally.

§Examples

use lambda_lw_http_router_core::{RouterBuilder, RouteContext};
use serde_json::{json, Value};
use lambda_runtime::Error;
use aws_lambda_events::apigw::ApiGatewayV2httpRequest;

#[derive(Clone)]
struct State {}

async fn get_users(ctx: RouteContext<State, ApiGatewayV2httpRequest>) -> Result<Value, Error> {
    Ok(json!({ "users": [] }))
}

async fn create_user(ctx: RouteContext<State, ApiGatewayV2httpRequest>) -> Result<Value, Error> {
    Ok(json!({ "status": "created" }))
}

let router = RouterBuilder::<State, ApiGatewayV2httpRequest>::new()
    .route("GET", "/users", get_users)
    .route("POST", "/users", create_user)
    .build();

Implementations§

Source§

impl<State, E> RouterBuilder<State, E>
where E: RoutableHttpEvent, State: Send + Sync + Clone + 'static,

Source

pub fn new() -> RouterBuilder<State, E>

Source

pub fn route<F, Fut>( self, method: &str, path: &str, handler: F, ) -> RouterBuilder<State, E>
where F: Fn(RouteContext<State, E>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, Box<dyn Error + Send + Sync>>> + Send + 'static,

Source

pub fn build(self) -> Router<State, E>

Source

pub fn from_registry() -> RouterBuilder<State, E>

Trait Implementations§

Source§

impl<State, E> Default for RouterBuilder<State, E>
where E: RoutableHttpEvent, State: Send + Sync + Clone + 'static,

Source§

fn default() -> RouterBuilder<State, E>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<State, E> Freeze for RouterBuilder<State, E>

§

impl<State, E> !RefUnwindSafe for RouterBuilder<State, E>

§

impl<State, E> Send for RouterBuilder<State, E>

§

impl<State, E> Sync for RouterBuilder<State, E>

§

impl<State, E> Unpin for RouterBuilder<State, E>

§

impl<State, E> !UnwindSafe for RouterBuilder<State, E>

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

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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<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