Struct JsonOutput

Source

pub struct JsonOutput {
    pub matches: Vec<JsonMatchResult>,
}

Expand description

JSON output structure containing an array of matches

This structure represents the complete JSON output format for file type detection results, containing an array of matches that can be serialized to JSON for programmatic consumption.

§Examples

use libmagic_rs::output::json::{JsonOutput, JsonMatchResult};

let json_output = JsonOutput {
    matches: vec![
        JsonMatchResult::new(
            "ELF executable".to_string(),
            0,
            "7f454c46".to_string(),
            vec!["executable".to_string(), "elf".to_string()],
            90
        )
    ]
};

assert_eq!(json_output.matches.len(), 1);

Fields§

§matches: Vec<JsonMatchResult>

Array of match results found during evaluation

Implementations§

Source §

impl JsonOutput

Source

pub fn new(matches: Vec<JsonMatchResult>) -> Self

Create a new JSON output structure

§Arguments

matches - Vector of JSON match results

§Examples

use libmagic_rs::output::json::{JsonOutput, JsonMatchResult};

let matches = vec![
    JsonMatchResult::new(
        "Text file".to_string(),
        0,
        "48656c6c6f".to_string(),
        vec!["text".to_string()],
        60
    )
];

let output = JsonOutput::new(matches);
assert_eq!(output.matches.len(), 1);

Source

pub fn from_evaluation_result(result: &EvaluationResult) -> Self

Create JSON output from an EvaluationResult

Converts the internal evaluation result to the JSON format specified in the original libmagic specification.

§Arguments

result - The evaluation result to convert

§Examples

use libmagic_rs::output::{EvaluationResult, MatchResult, EvaluationMetadata, json::JsonOutput};
use libmagic_rs::parser::ast::Value;
use std::path::PathBuf;

let match_result = MatchResult::with_metadata(
    "Binary data".to_string(),
    0,
    4,
    Value::Bytes(vec![0xde, 0xad, 0xbe, 0xef]),
    vec!["binary".to_string()],
    70,
    None
);

let metadata = EvaluationMetadata::new(1024, 1.5, 10, 1);
let eval_result = EvaluationResult::new(
    PathBuf::from("test.bin"),
    vec![match_result],
    metadata
);

let json_output = JsonOutput::from_evaluation_result(&eval_result);
assert_eq!(json_output.matches.len(), 1);
assert_eq!(json_output.matches[0].text, "Binary data");
assert_eq!(json_output.matches[0].value, "deadbeef");

Source

pub fn add_match(&mut self, match_result: JsonMatchResult)

Add a match result to the output

§Examples

use libmagic_rs::output::json::{JsonOutput, JsonMatchResult};

let mut output = JsonOutput::new(vec![]);

let match_result = JsonMatchResult::new(
    "PDF document".to_string(),
    0,
    "25504446".to_string(),
    vec!["document".to_string(), "pdf".to_string()],
    85
);

output.add_match(match_result);
assert_eq!(output.matches.len(), 1);

Source

pub fn has_matches(&self) -> bool

Check if there are any matches

§Examples

use libmagic_rs::output::json::JsonOutput;

let empty_output = JsonOutput::new(vec![]);
assert!(!empty_output.has_matches());

let output_with_matches = JsonOutput::new(vec![
    libmagic_rs::output::json::JsonMatchResult::new(
        "Test".to_string(),
        0,
        "74657374".to_string(),
        vec![],
        50
    )
]);
assert!(output_with_matches.has_matches());

Source

pub fn match_count(&self) -> usize

Get the number of matches

§Examples

use libmagic_rs::output::json::{JsonOutput, JsonMatchResult};

let matches = vec![
    JsonMatchResult::new("Match 1".to_string(), 0, "01".to_string(), vec![], 50),
    JsonMatchResult::new("Match 2".to_string(), 10, "02".to_string(), vec![], 60),
];

let output = JsonOutput::new(matches);
assert_eq!(output.match_count(), 2);