Struct MistralRsServerRouterBuilder

pub struct MistralRsServerRouterBuilder { /* private fields */ }

A builder for creating a mistral.rs server router with configurable options.

Examples

Basic usage:

use mistralrs_server_core::mistralrs_server_router_builder::MistralRsServerRouterBuilder;

let router = MistralRsServerRouterBuilder::new()
    .with_mistralrs(mistralrs_instance)
    .build()
    .await?;

With custom configuration:

use mistralrs_server_core::mistralrs_server_router_builder::MistralRsServerRouterBuilder;

let router = MistralRsServerRouterBuilder::new()
    .with_mistralrs(mistralrs_instance)
    .with_include_swagger_routes(false)
    .with_base_path("/api/mistral")
    .build()
    .await?;

Implementations

impl MistralRsServerRouterBuilder

pub fn new() -> Self

Creates a new MistralRsServerRouterBuilder with default settings.

This is equivalent to calling Default::default().

Examples

use mistralrs_server_core::mistralrs_server_router_builder::MistralRsServerRouterBuilder;

let builder = MistralRsServerRouterBuilder::new();

pub fn with_mistralrs(self, mistralrs: SharedMistralRsState) -> Self

Sets the shared mistral.rs instance

pub fn with_include_swagger_routes(self, include_swagger_routes: bool) -> Self

Configures whether to include OpenAPI doc routes.

When enabled (default), the router will include routes for Swagger UI at /docs and the OpenAPI specification at /api-doc/openapi.json. These routes respect the configured base path if one is set.

pub fn with_base_path(self, base_path: &str) -> Self

Sets a base path prefix for all routes.

When set, all routes will be prefixed with the given path. This is useful when including the mistral.rs server instance in another axum project.

pub fn with_allowed_origins(self, origins: Vec<String>) -> Self

Sets the CORS allowed origins.

pub fn with_max_body_limit(self, max_body_limit: usize) -> Self

Sets the axum default request body limit.

pub async fn build(self) -> Result<Router>

Builds the configured axum router.

Examples

use mistralrs_server_core::mistralrs_server_router_builder::MistralRsServerRouterBuilder;

let router = MistralRsServerRouterBuilder::new()
    .with_mistralrs(mistralrs_instance)
    .build()
    .await?;

Trait Implementations

impl Default for MistralRsServerRouterBuilder

fn default() -> Self

Creates a new builder with default configuration.