Skip to main content

Router

Struct Router 

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

A runtime HTTP router.

Routes are dispatched through a per-method radix trie (matchit). The trie matches on the request path; a per-route match_fn then validates typed captures (e.g. that {} parses as u32). Patterns that conflict in the trie fall back to a linear scan within the same method bucket, so registration never silently drops a route.

Implementations§

Source§

impl Router

Source

pub fn new() -> Self

Create an empty router.

Source

pub fn route( self: &Arc<Self>, req: Request<Incoming>, ) -> Pin<Box<dyn Future<Output = Response<BoxBody>> + Send>>

Route a request to the appropriate handler.

Must be called on Arc<Router> so the router outlives the returned future. The body is collected into bytes before handler dispatch, enabling both Hyper and Axum body types to be handled uniformly.

Source

pub fn route_with_bytes( self: &Arc<Self>, parts: Parts, body_bytes: Bytes, ) -> Pin<Box<dyn Future<Output = Response<BoxBody>> + Send>>

Route a request whose body has already been collected into bytes::Bytes.

Used by adapters that have a different body type from hyper::body::Incoming (e.g. the Axum interop layer), and by anything that has already buffered a body for an unrelated reason. Bypasses the max_body_size check; the caller is responsible for any size limiting.

Trait Implementations§

Source§

impl Default for Router

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl !Freeze for Router

§

impl !RefUnwindSafe for Router

§

impl Send for Router

§

impl Sync for Router

§

impl Unpin for Router

§

impl UnsafeUnpin for Router

§

impl !UnwindSafe for Router

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<B, C, R, H> Serves<VersionedApi<B, C, R>> for H
where R: ApiSpec, H: Serves<R>,

Source§

fn register(self, router: &mut Router)

Register all handlers into the router.
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
Source§

impl<T> IsEndpoint<T> for T