Struct IncludeConfig 

pub struct IncludeConfig { /* private fields */ }

Configuration for including a router with overrides.

When including a router in an app or another router, this config allows overriding or prepending settings to the included router.

Merge Rules (per FastAPI spec)

1. prefix: Prepended to router’s prefix
2. tags: Prepended to router’s tags
3. dependencies: Prepended to router’s dependencies
4. responses: Merged (route > router > config)
5. deprecated: Override if provided
6. include_in_schema: Override if provided

Example

let config = IncludeConfig::new()
    .prefix("/api/v1")
    .tags(vec!["api"])
    .dependency(auth_dep);

let app = App::builder()
    .include_router_with_config(router, config)
    .build();

Implementations

impl IncludeConfig

pub fn new() -> Self

Creates a new empty include configuration.

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

Sets the prefix to prepend to the router’s prefix.

pub fn tags(self, tags: Vec<impl Into<String>>) -> Self

Sets the tags to prepend to the router’s tags.

pub fn tag(self, tag: impl Into<String>) -> Self

Adds a single tag to prepend.

pub fn dependency(self, dep: RouterDependency) -> Self

Adds a dependency to prepend.

pub fn dependencies(self, deps: Vec<RouterDependency>) -> Self

Sets dependencies to prepend.

pub fn response(self, status_code: u16, def: ResponseDef) -> Self

Adds a response definition.

pub fn responses(self, responses: HashMap<u16, ResponseDef>) -> Self

Sets response definitions.

pub fn deprecated(self, deprecated: bool) -> Self

Sets the deprecated override.

pub fn include_in_schema(self, include: bool) -> Self

Sets the include_in_schema override.

pub fn get_prefix(&self) -> Option<&str>

Returns the prefix.

pub fn get_tags(&self) -> &[String]

Returns the tags.

pub fn get_dependencies(&self) -> &[RouterDependency]

Returns the dependencies.

pub fn get_responses(&self) -> &HashMap<u16, ResponseDef>

Returns the responses.

pub fn get_deprecated(&self) -> Option<bool>

Returns the deprecated override.

pub fn get_include_in_schema(&self) -> Option<bool>

Returns the include_in_schema override.

Trait Implementations

impl Clone for IncludeConfig

fn clone(&self) -> IncludeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncludeConfig

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

Formats the value using the given formatter.

impl Default for IncludeConfig

fn default() -> IncludeConfig

Returns the “default value” for a type.