Skip to main content

RouteGroup

Struct RouteGroup 

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

A group of HTTP routes that share a common path prefix (and optionally shared per-route Tower layers).

See HttpIngress::route_group for usage examples.

Implementations§

Source§

impl<R> RouteGroup<R>
where R: ResourceRequirement + Clone + Send + Sync + 'static,

Source

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

Create a new RouteGroup with the given path prefix.

The prefix is automatically normalised: a leading / is added if absent, and a trailing / is removed.

Source

pub fn get<Out, E>( self, sub_path: impl Into<String>, circuit: Axon<(), Out, E, R>, ) -> Self
where Out: IntoResponse + Send + Sync + 'static, E: Send + 'static + Debug,

Register a GET route relative to this group’s prefix.

Source

pub fn post<Out, E>( self, sub_path: impl Into<String>, circuit: Axon<(), Out, E, R>, ) -> Self
where Out: IntoResponse + Send + Sync + 'static, E: Send + 'static + Debug,

Register a POST route relative to this group’s prefix.

Source

pub fn put<Out, E>( self, sub_path: impl Into<String>, circuit: Axon<(), Out, E, R>, ) -> Self
where Out: IntoResponse + Send + Sync + 'static, E: Send + 'static + Debug,

Register a PUT route relative to this group’s prefix.

Source

pub fn patch<Out, E>( self, sub_path: impl Into<String>, circuit: Axon<(), Out, E, R>, ) -> Self
where Out: IntoResponse + Send + Sync + 'static, E: Send + 'static + Debug,

Register a PATCH route relative to this group’s prefix.

Source

pub fn delete<Out, E>( self, sub_path: impl Into<String>, circuit: Axon<(), Out, E, R>, ) -> Self
where Out: IntoResponse + Send + Sync + 'static, E: Send + 'static + Debug,

Register a DELETE route relative to this group’s prefix.

Source

pub fn method<Out, E>( self, method: Method, sub_path: impl Into<String>, circuit: Axon<(), Out, E, R>, ) -> Self
where Out: IntoResponse + Send + Sync + 'static, E: Send + 'static + Debug,

Register a route with an arbitrary HTTP method relative to this group’s prefix.

Source

pub fn group(self, child: RouteGroup<R>) -> Self

Nest a child RouteGroup inside this group.

The child’s prefix is appended to the parent’s prefix.

Auto Trait Implementations§

§

impl<R> Freeze for RouteGroup<R>

§

impl<R = ()> !RefUnwindSafe for RouteGroup<R>

§

impl<R> Send for RouteGroup<R>

§

impl<R> Sync for RouteGroup<R>

§

impl<R> Unpin for RouteGroup<R>

§

impl<R> UnsafeUnpin for RouteGroup<R>

§

impl<R = ()> !UnwindSafe for RouteGroup<R>

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