Struct DataResponse 

#[non_exhaustive]
pub struct DataResponse {
    pub success: bool,
    pub data: Option<Vec<SqlmapDataChunk>>,
    pub error: Option<Vec<String>>,
    pub message: Option<String>,
}

Final payload block returning all gathered data for a task.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

success: bool

True if fetch succeeded.

data: Option<Vec<SqlmapDataChunk>>

The aggregated data chunks representing injection results.

error: Option<Vec<String>>

Array of structured errors from the engine.

message: Option<String>

Error or informational message when success is false.

Implementations

impl DataResponse

pub fn findings(&self) -> Vec<SqlmapFinding>

Extract structured findings from the raw data chunks.

Type 1 chunks are sqlmapapi TECHNIQUES payloads: each value entry is an injection point with a nested data[] of {title|technique, payload}. Flat legacy objects with top-level type/payload are still accepted.

Examples found in repository

examples/full_scan.rs (line 76)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // ── 1. Check availability ────────────────────────────
    if !SqlmapEngine::is_available() {
        eprintln!("ERROR: sqlmapapi not found in PATH");
        eprintln!("Quick fix:");
        eprintln!("  conda env create -f environment.yml");
        eprintln!("  conda activate sqlmap-env");
        eprintln!("  # OR: ./setup.sh");
        std::process::exit(1);
    }

    // ── 2. Boot the daemon ───────────────────────────────
    println!("Booting sqlmapapi daemon on port 8775...");
    let engine = SqlmapEngine::new(8775, true, None).await?;
    println!("Daemon ready at {}", engine.api_url());

    // ── 3. Configure scan with builder ───────────────────
    let target = std::env::args().nth(1).unwrap_or_else(|| {
        eprintln!("Usage: cargo run --example full_scan -- <target-url>");
        eprintln!("Example: cargo run --example full_scan -- http://example.com/page?id=1");
        std::process::exit(1);
    });

    println!("Target: {target}");

    let opts = SqlmapOptions::builder()
        .url(&target)
        .level(3)
        .risk(2)
        .batch(true)
        .threads(4)
        .random_agent(true)
        .build();

    // ── 4. Create and run task ───────────────────────────
    let task = engine.create_task(&opts).await?;
    println!("Task created: {}", task.task_id());

    task.start().await?;
    println!("Scan started, polling for completion...");

    // ── 5. Monitor execution ─────────────────────────────
    task.wait_for_completion(300).await?;
    println!("Scan complete!");

    // ── 6. Fetch and display logs ────────────────────────
    match task.fetch_log().await {
        Ok(log_resp) => {
            if let Some(logs) = &log_resp.log {
                println!("\n=== Scan Log ({} entries) ===", logs.len());
                for entry in logs.iter().rev().take(10) {
                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
                }
                if logs.len() > 10 {
                    println!("  ... and {} more entries", logs.len() - 10);
                }
            }
        }
        Err(err) => eprintln!("Could not fetch log: {err}"),
    }

    // ── 7. Fetch results ─────────────────────────────────
    let data = task.fetch_data().await?;
    let findings = data.findings();

    println!("\n=== Results ===");
    println!("  Findings: {}", findings.len());

    if findings.is_empty() {
        println!("  No SQL injection vulnerabilities detected.");
    } else {
        // ── 8. Multi-format output ───────────────────────
        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));

        println!("=== JSON ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));

        println!("=== CSV ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));

        println!("=== Markdown ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
    }

    // ── 9. Inspect configured options ────────────────────
    match task.list_options().await {
        Ok(options) => {
            println!("\n=== Active Options ===");
            println!("{}", serde_json::to_string_pretty(&options)?);
        }
        Err(err) => eprintln!("Could not fetch options: {err}"),
    }

    // Task is auto-deleted from daemon on drop.
    // Engine daemon is auto-killed on drop.
    println!("\nDone. Task and daemon will be cleaned up automatically.");

    Ok(())
}

Trait Implementations

impl Clone for DataResponse

fn clone(&self) -> DataResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DataResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.