pub struct Router { /* private fields */ }
Expand description
Router for the HTTP trigger.
Implementations§
Source§impl Router
impl Router
Sourcepub fn build<'a>(
base: &str,
component_routes: impl IntoIterator<Item = (&'a str, &'a HttpTriggerRouteConfig)>,
duplicate_routes: Option<&mut Vec<DuplicateRoute>>,
) -> Result<Self>
pub fn build<'a>( base: &str, component_routes: impl IntoIterator<Item = (&'a str, &'a HttpTriggerRouteConfig)>, duplicate_routes: Option<&mut Vec<DuplicateRoute>>, ) -> Result<Self>
Builds a router based on application configuration.
duplicate_routes
is an optional mutable reference to a vector of DuplicateRoute
that will be populated with any duplicate routes found during the build process.
Sourcepub fn routes(&self) -> impl Iterator<Item = (&(impl Display + Debug), &String)>
pub fn routes(&self) -> impl Iterator<Item = (&(impl Display + Debug), &String)>
Returns the constructed routes.
Sourcepub fn contains_reserved_route(&self) -> bool
pub fn contains_reserved_route(&self) -> bool
true if one or more routes is under the reserved /.well-known/spin/*
prefix; otherwise false.
Sourcepub fn route<'path, 'router: 'path>(
&'router self,
path: &'path str,
) -> Result<RouteMatch<'router, 'path>>
pub fn route<'path, 'router: 'path>( &'router self, path: &'path str, ) -> Result<RouteMatch<'router, 'path>>
This returns the component ID that should handle the given path, or an error if no component matches.
If multiple components could potentially handle the same request based on their defined routes, components with matching exact routes take precedence followed by matching wildcard patterns with the longest matching prefix.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Router
impl RefUnwindSafe for Router
impl Send for Router
impl Sync for Router
impl Unpin for Router
impl UnwindSafe for Router
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more