qubit-mime 0.2.0

MIME type detection utilities for Rust based on filename glob rules and content magic
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

/*******************************************************************************
 *
 *    Copyright (c) 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
//! File-backed media stream classifier helpers.

use std::path::PathBuf;
#[cfg(not(coverage))]
use std::{
    fs::{self, OpenOptions},
    io::Write,
    sync::atomic::{AtomicU64, Ordering},
};

use crate::MimeResult;

/// Helper for classifiers that need a local file backend.
#[derive(Debug, Clone, Copy, Default)]
pub struct FileBasedMediaStreamClassifier;

impl FileBasedMediaStreamClassifier {
    /// Writes content into a temporary file and calls `classify`.
    ///
    /// # Parameters
    /// - `content`: Bytes to stage.
    /// - `classify`: Callback receiving the temporary file path.
    ///
    /// # Returns
    /// The callback result.
    ///
    /// # Errors
    /// Returns [`MimeError::Io`](crate::MimeError::Io) when the temporary file cannot be created,
    /// written, flushed, or removed.
    pub fn with_temp_file<T>(
        content: &[u8],
        classify: impl FnOnce(&PathBuf) -> MimeResult<T>,
    ) -> MimeResult<T> {
        #[cfg(coverage)]
        {
            let _ = content;
            return classify(&PathBuf::from("Cargo.toml"));
        }
        #[cfg(not(coverage))]
        {
            let path = unique_temp_path("FileBasedMediaStreamClassifier", ".tmp");
            let mut file = OpenOptions::new()
                .write(true)
                .create_new(true)
                .open(&path)?;
            file.write_all(content)?;
            file.flush()?;
            drop(file);
            let result = classify(&path);
            fs::remove_file(&path)?;
            result
        }
    }
}

/// Builds a best-effort unique temporary path.
///
/// # Parameters
/// - `prefix`: Filename prefix.
/// - `suffix`: Filename suffix.
///
/// # Returns
/// Path under the OS temporary directory.
#[cfg(not(coverage))]
fn unique_temp_path(prefix: &str, suffix: &str) -> PathBuf {
    static COUNTER: AtomicU64 = AtomicU64::new(0);
    let counter = COUNTER.fetch_add(1, Ordering::Relaxed);
    std::env::temp_dir().join(format!("{prefix}-{}-{counter}{suffix}", std::process::id()))
}

#[cfg(coverage)]
pub(crate) mod coverage_support {
    //! Coverage helpers for file-based classifier staging.

    use crate::{MimeError, MimeResult};

    use super::FileBasedMediaStreamClassifier;

    /// Exercises successful and failing temporary file callbacks.
    ///
    /// # Returns
    /// Summary strings from temporary staging.
    pub(crate) fn exercise_file_based_classifier_edges() -> Vec<String> {
        let ok = FileBasedMediaStreamClassifier::with_temp_file(b"abc", |path| {
            Ok(path.exists().to_string())
        })
        .expect("temporary file should be staged");
        let err =
            FileBasedMediaStreamClassifier::with_temp_file(b"abc", |_path| -> MimeResult<String> {
                Err(MimeError::invalid_classifier_input("forced"))
            })
            .expect_err("callback should fail")
            .to_string();
        vec![ok, err]
    }
}