Struct JsonLineOutput

Source

pub struct JsonLineOutput {
    pub filename: String,
    pub matches: Vec<JsonMatchResult>,
}

Expand description

JSON Lines output structure with filename and matches

This structure is used for multi-file JSON output, where each line represents one file’s results. It includes the filename alongside the match results to provide context in a streaming format.

JSON Lines format is used when processing multiple files to provide immediate per-file output and clear filename association.

§Examples

use libmagic_rs::output::json::{JsonLineOutput, JsonMatchResult};
use std::path::PathBuf;

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

let output = JsonLineOutput::new("file.bin".to_string(), matches);
assert_eq!(output.filename, "file.bin");
assert_eq!(output.matches.len(), 1);

Fields§

§filename: String

Filename or path of the analyzed file

§matches: Vec<JsonMatchResult>

Array of match results found during evaluation

Implementations§

Source §

impl JsonLineOutput

Source

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

Create a new JSON Lines output structure

§Arguments

filename - The filename or path as a string
matches - Vector of JSON match results

§Examples

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

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

let output = JsonLineOutput::new("test.txt".to_string(), matches);
assert_eq!(output.filename, "test.txt");
assert_eq!(output.matches.len(), 1);

Source

pub fn from_match_results( filename: &Path, match_results: &[MatchResult], ) -> Self

Create JSON Lines output from match results and filename

§Arguments

filename - Path to the analyzed file
match_results - Vector of match results to convert

§Examples

use libmagic_rs::output::{MatchResult, json::JsonLineOutput};
use libmagic_rs::parser::ast::Value;
use std::path::Path;

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

let output = JsonLineOutput::from_match_results(Path::new("test.bin"), &match_results);
assert_eq!(output.filename, "test.bin");
assert_eq!(output.matches.len(), 1);