pavex/blueprint/routes.rs
1use pavex_bp_schema::Blueprint as BlueprintSchema;
2
3/// The type returned by [`Blueprint::routes`].
4///
5/// # Future-proofing
6///
7/// As of today, [`RegisteredRoutes`] doesn't provide any additional functionality.\
8/// It is included to allow introducing new configuration for route groups without having
9/// to change the signature of [`Blueprint::routes`].
10///
11/// [`Blueprint::routes`]: crate::Blueprint::routes
12pub struct RegisteredRoutes<'a> {
13 #[allow(unused)]
14 pub(crate) blueprint: &'a mut BlueprintSchema,
15 /// The index of the registered routes import in the blueprint's `components` vector.
16 #[allow(unused)]
17 pub(crate) component_id: usize,
18}