Struct actix_router::Router

source ·
pub struct Router<T, U = ()> { /* private fields */ }
Expand description

Resource router.

It matches a routing resource to an ordered list of routes. Each is defined by a single ResourceDef and contains two types of custom data:

  1. The route value, of the generic type T.
  2. Some context data, of the generic type U, which is only provided to the check function in recognize_fn. This parameter defaults to () and can be omitted if not required.

Implementations§

source§

impl<T, U> Router<T, U>

source

pub fn build() -> RouterBuilder<T, U>

Constructs new RouterBuilder with empty route list.

source

pub fn recognize<R>(&self, resource: &mut R) -> Option<(&T, ResourceId)>where R: Resource,

Finds the value in the router that matches a given routing resource.

The match result, including the captured dynamic segments, in the resource.

source

pub fn recognize_mut<R>( &mut self, resource: &mut R ) -> Option<(&mut T, ResourceId)>where R: Resource,

Same as recognize but returns a mutable reference to the matched value.

source

pub fn recognize_fn<R, F>( &self, resource: &mut R, check: F ) -> Option<(&T, ResourceId)>where R: Resource, F: FnMut(&R, &U) -> bool,

Finds the value in the router that matches a given routing resource and passes an additional predicate check using context data.

Similar to recognize. However, before accepting the route as matched, the check closure is executed, passing the resource and each route’s context data. If the closure returns true then the match result is stored into resource and a reference to the matched value is returned.

source

pub fn recognize_mut_fn<R, F>( &mut self, resource: &mut R, check: F ) -> Option<(&mut T, ResourceId)>where R: Resource, F: FnMut(&R, &U) -> bool,

Same as recognize_fn but returns a mutable reference to the matched value.

Auto Trait Implementations§

§

impl<T, U> RefUnwindSafe for Router<T, U>where T: RefUnwindSafe, U: RefUnwindSafe,

§

impl<T, U> Send for Router<T, U>where T: Send, U: Send,

§

impl<T, U> Sync for Router<T, U>where T: Sync, U: Sync,

§

impl<T, U> Unpin for Router<T, U>where T: Unpin, U: Unpin,

§

impl<T, U> UnwindSafe for Router<T, U>where T: UnwindSafe, U: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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