Struct ServerConfig 

pub struct ServerConfig {
    pub port: u16,
    pub host: String,
    pub add_current_server: bool,
    pub exclude_headers: Vec<String>,
    pub static_dir: Option<PathBuf>,
}

Configuration for the HTTPCan server

Fields

port: u16

Port to bind the server to

host: String

Host address to bind to (default: “0.0.0.0”)

add_current_server: bool

Whether to add current server to OpenAPI specification

exclude_headers: Vec<String>

Headers to exclude from responses

static_dir: Option<PathBuf>

Custom static files directory

Implementations

impl ServerConfig

pub fn new() -> Self

Create a new server configuration with default values

Examples found in repository

examples/basic.rs (line 25)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize logging
    env_logger::init();

    // Method 1: Using default configuration
    println!("Starting HTTPCan server with default configuration...");
    
    // Create server with default settings (port 8080, all features enabled)
    let _server = HttpCanServer::new();
    
    // Method 2: Using builder pattern
    let server = HttpCanServer::new()
        .port(3000)
        .host("127.0.0.1")
        .add_current_server(true)
        .exclude_header("x-internal-header")
        .exclude_header("x-debug-*");
    
    // Method 3: Using ServerConfig
    let config = ServerConfig::new()
        .port(3000)
        .host("127.0.0.1")
        .add_current_server(true)
        .exclude_headers(vec![
            "x-internal-header".to_string(),
            "x-debug-*".to_string(),
        ]);
    
    let _server_with_config = HttpCanServer::with_config(config);
    
    // Start the server
    server.run().await?;
    
    Ok(())
}

pub fn port(self, port: u16) -> Self

Set the port for the server

Examples found in repository

examples/basic.rs (line 26)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize logging
    env_logger::init();

    // Method 1: Using default configuration
    println!("Starting HTTPCan server with default configuration...");
    
    // Create server with default settings (port 8080, all features enabled)
    let _server = HttpCanServer::new();
    
    // Method 2: Using builder pattern
    let server = HttpCanServer::new()
        .port(3000)
        .host("127.0.0.1")
        .add_current_server(true)
        .exclude_header("x-internal-header")
        .exclude_header("x-debug-*");
    
    // Method 3: Using ServerConfig
    let config = ServerConfig::new()
        .port(3000)
        .host("127.0.0.1")
        .add_current_server(true)
        .exclude_headers(vec![
            "x-internal-header".to_string(),
            "x-debug-*".to_string(),
        ]);
    
    let _server_with_config = HttpCanServer::with_config(config);
    
    // Start the server
    server.run().await?;
    
    Ok(())
}

pub fn host<S: Into<String>>(self, host: S) -> Self

Set the host address for the server

Examples found in repository

examples/basic.rs (line 27)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize logging
    env_logger::init();

    // Method 1: Using default configuration
    println!("Starting HTTPCan server with default configuration...");
    
    // Create server with default settings (port 8080, all features enabled)
    let _server = HttpCanServer::new();
    
    // Method 2: Using builder pattern
    let server = HttpCanServer::new()
        .port(3000)
        .host("127.0.0.1")
        .add_current_server(true)
        .exclude_header("x-internal-header")
        .exclude_header("x-debug-*");
    
    // Method 3: Using ServerConfig
    let config = ServerConfig::new()
        .port(3000)
        .host("127.0.0.1")
        .add_current_server(true)
        .exclude_headers(vec![
            "x-internal-header".to_string(),
            "x-debug-*".to_string(),
        ]);
    
    let _server_with_config = HttpCanServer::with_config(config);
    
    // Start the server
    server.run().await?;
    
    Ok(())
}

pub fn add_current_server(self, add: bool) -> Self

Enable or disable adding current server to OpenAPI specification

Examples found in repository

examples/basic.rs (line 28)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize logging
    env_logger::init();

    // Method 1: Using default configuration
    println!("Starting HTTPCan server with default configuration...");
    
    // Create server with default settings (port 8080, all features enabled)
    let _server = HttpCanServer::new();
    
    // Method 2: Using builder pattern
    let server = HttpCanServer::new()
        .port(3000)
        .host("127.0.0.1")
        .add_current_server(true)
        .exclude_header("x-internal-header")
        .exclude_header("x-debug-*");
    
    // Method 3: Using ServerConfig
    let config = ServerConfig::new()
        .port(3000)
        .host("127.0.0.1")
        .add_current_server(true)
        .exclude_headers(vec![
            "x-internal-header".to_string(),
            "x-debug-*".to_string(),
        ]);
    
    let _server_with_config = HttpCanServer::with_config(config);
    
    // Start the server
    server.run().await?;
    
    Ok(())
}

pub fn exclude_headers(self, headers: Vec<String>) -> Self

Set headers to exclude from responses

Examples found in repository

examples/basic.rs (lines 29-32)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize logging
    env_logger::init();

    // Method 1: Using default configuration
    println!("Starting HTTPCan server with default configuration...");
    
    // Create server with default settings (port 8080, all features enabled)
    let _server = HttpCanServer::new();
    
    // Method 2: Using builder pattern
    let server = HttpCanServer::new()
        .port(3000)
        .host("127.0.0.1")
        .add_current_server(true)
        .exclude_header("x-internal-header")
        .exclude_header("x-debug-*");
    
    // Method 3: Using ServerConfig
    let config = ServerConfig::new()
        .port(3000)
        .host("127.0.0.1")
        .add_current_server(true)
        .exclude_headers(vec![
            "x-internal-header".to_string(),
            "x-debug-*".to_string(),
        ]);
    
    let _server_with_config = HttpCanServer::with_config(config);
    
    // Start the server
    server.run().await?;
    
    Ok(())
}

pub fn exclude_header<S: Into<String>>(self, header: S) -> Self

Add a header to exclude from responses

pub fn static_dir<P: Into<PathBuf>>(self, dir: P) -> Self

Set custom static files directory

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> Self

Returns the “default value” for a type.