Struct Router

pub struct Router { /* private fields */ }

Router for the HTTP trigger.

Implementations

impl Router

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.

pub fn routes(&self) -> impl Iterator<Item = (&(impl Display + Debug), &String)>

Returns the constructed routes.

pub fn contains_reserved_route(&self) -> bool

true if one or more routes is under the reserved /.well-known/spin/* prefix; otherwise false.

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

impl Clone for Router

fn clone(&self) -> Router

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Router

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.