Skip to main content

Router

anvil_core::route

Struct Router 

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

Implementations§

Source§

impl Router

Source

pub fn new(registry: MiddlewareRegistry) -> Self

Source

pub fn route_infos(&self) -> &[RouteInfo]

Borrow the route registry collected during construction.

Source

pub fn with_state(self) -> AxumRouter<Container>

Source

pub fn finish(self) -> (AxumRouter<Container>, Vec<RouteInfo>)

Same as with_state, but also returns the captured RouteInfo list so the Application can hold onto it for anvil routes.

Source

pub fn get<H, T>(self, path: &str, handler: H) -> Self
where H: Handler<T, Container>, T: 'static,

Source

pub fn post<H, T>(self, path: &str, handler: H) -> Self
where H: Handler<T, Container>, T: 'static,

Source

pub fn put<H, T>(self, path: &str, handler: H) -> Self
where H: Handler<T, Container>, T: 'static,

Source

pub fn patch<H, T>(self, path: &str, handler: H) -> Self
where H: Handler<T, Container>, T: 'static,

Source

pub fn delete<H, T>(self, path: &str, handler: H) -> Self
where H: Handler<T, Container>, T: 'static,

Source

pub fn any<H, T>(self, path: &str, handler: H) -> Self
where H: Handler<T, Container>, T: 'static,

Source

pub fn prefix(self, prefix: impl Into<String>) -> Self

Source

pub fn middleware<I, S>(self, names: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn group<F>(self, build: F) -> Self
where F: FnOnce(Router) -> Router,

Source

pub fn merge(self, other: Router) -> Self

Source

pub fn nest(self, prefix: &str, other: Router) -> Self

Source

pub fn with_route_infos(self, infos: Vec<RouteInfo>) -> Self

Replace the captured RouteInfo list. Used by Router::adopt when pulling in routes whose metadata is tracked elsewhere.

Source

pub fn layer<L>(self, layer: L) -> Self
where L: Layer<Route> + Clone + Send + Sync + 'static, L::Service: Service<Request<Body>, Response = Response<Body>, Error = Infallible> + Clone + Send + 'static, <L::Service as Service<Request<Body>>>::Future: Send + 'static,

Apply a tower layer to every route on this router. Used by extension crates (e.g. Spark’s spark.scope per-request middleware) to wrap all user routes without each one having to opt in by name.

Source

pub fn adopt(self, other: AxumRouter<Container>) -> Self

Adopt a raw axum::Router<Container> — useful when a crate has already built its routes with its own layered stack and just wants to merge them in.

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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