Skip to main content

OxideRouter

Struct OxideRouter 

Source
pub struct OxideRouter<S = ()> { /* private fields */ }
Expand description

Thin wrapper around axum::Router that provides a simplified registration API with support for grouping, nesting, and merging.

Implementations§

Source§

impl<S: Clone + Send + Sync + 'static> OxideRouter<S>

Source

pub fn new() -> Self

Source

pub fn from_router(router: Router<S>) -> Self

Wrap an existing axum::Router in an OxideRouter.

Source

pub fn nest_self(self, prefix: &str) -> Self

Nest this router under a prefix, consuming and returning self. Handles empty and “/” prefixes natively via merge (Axum 0.8 compatibility).

Source

pub fn route<H, T>(self, method: Method, path: &str, handler: H) -> Self
where H: Handler<T, S>, T: 'static,

Register a handler for the given method and path.

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn merge(self, other: OxideRouter<S>) -> Self

Merge another OxideRouter into this one (flat merge, no prefix).

Source

pub fn nest(self, prefix: &str, other: OxideRouter<S>) -> Self

Nest a sub-router under the given prefix. Handles empty and “/” prefixes gracefully.

let api = OxideRouter::new()
    .get("/users", list_users)
    .post("/users", create_user);

let app_router = OxideRouter::new()
    .nest("/api", api);
// produces: GET /api/users, POST /api/users
Source

pub fn into_inner(self) -> Router<S>

Consume the wrapper and return the underlying axum::Router.

Auto Trait Implementations§

§

impl<S> Freeze for OxideRouter<S>

§

impl<S = ()> !RefUnwindSafe for OxideRouter<S>

§

impl<S> Send for OxideRouter<S>

§

impl<S> Sync for OxideRouter<S>

§

impl<S> Unpin for OxideRouter<S>

§

impl<S> UnsafeUnpin for OxideRouter<S>

§

impl<S = ()> !UnwindSafe for OxideRouter<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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,