kreuzcrawl 0.2.0

High-performance web crawling engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! API server startup functions.

use std::net::{IpAddr, SocketAddr};
use std::sync::Arc;

use crate::engine::CrawlEngine;
use crate::error::CrawlError;
use crate::types::CrawlConfig;

use super::router::create_router;

/// Start the API server with a pre-built engine.
///
/// # Arguments
///
/// * `host` - IP address to bind to (e.g. `"127.0.0.1"` or `"0.0.0.0"`)
/// * `port` - Port number to bind to
/// * `engine` - A shared [`CrawlEngine`] that powers all operations
///
/// # Errors
///
/// Returns a [`CrawlError`] if the address is invalid or the server fails to start.
pub async fn serve(host: &str, port: u16, engine: Arc<CrawlEngine>) -> Result<(), CrawlError> {
    let ip: IpAddr = host
        .parse()
        .map_err(|e| CrawlError::InvalidConfig(format!("invalid host address: {e}")))?;

    let addr = SocketAddr::new(ip, port);
    let app = create_router(engine);

    let listener = tokio::net::TcpListener::bind(addr)
        .await
        .map_err(|e| CrawlError::Other(format!("failed to bind {addr}: {e}")))?;

    axum::serve(listener, app)
        .await
        .map_err(|e| CrawlError::Other(format!("server error: {e}")))?;

    Ok(())
}

/// Start the API server with a [`CrawlConfig`], building the engine internally.
///
/// Convenience wrapper that constructs a default [`CrawlEngine`] from the given config.
///
/// # Arguments
///
/// * `host` - IP address to bind to
/// * `port` - Port number to bind to
/// * `config` - Crawl configuration for the engine
///
/// # Errors
///
/// Returns a [`CrawlError`] if the config is invalid, the address cannot be
/// parsed, or the server fails to start.
pub async fn serve_with_config(host: &str, port: u16, config: CrawlConfig) -> Result<(), CrawlError> {
    let engine = CrawlEngine::builder().config(config).build()?;
    serve(host, port, Arc::new(engine)).await
}