Merge pull request #73 from theseus-rs/add-magic-benchmark

chore: add magic crate benchmark

Author: brianheineman

.github/workflows/benchmarks.yml

@@ -13,7 +13,7 @@ permissions:
 jobs:
   benchmark:
     name: Run Benchmarks
-    runs-on: macos-14
+    runs-on: ubuntu-latest
     permissions:
       pull-requests: write
     steps:
@@ -29,6 +29,9 @@ jobs:
       - name: Install benchmarking tools
         uses: bencherdev/bencher@main
 
+      - name: Install crate dependencies
+        run: sudo apt-get install libmagic1 libmagic-dev
+
       - name: Run benchmarks
         if: ${{ github.event_name == 'pull_request' }}
         env:

Cargo.lock

@@ -36,6 +36,7 @@ csv = "1.3.1"
 file-format = "0.26.0"
 infer = "0.19.0"
 indoc = "2.0.5"
+magic = "0.16.2"
 mime_guess = "2.0.5"
 quick-xml = "0.37.2"
 rayon = "1.5.1"

Cargo.toml

@@ -110,9 +110,10 @@ Data is licensed under the following licenses:
 
 If this crate does not meet your requirements, you may want to consider the following alternatives:
 
+* [file-format](https://crates.io/crates/file-format)
 * [infer](https://crates.io/crates/infer)
+* [magic](https://crates.io/crates/magic)
 * [mime_guess](https://crates.io/crates/mime_guess)
-* [file-format](https://crates.io/crates/file-format)
 
 ## Contribution
 

README.md

@@ -23,6 +23,7 @@ anyhow = { workspace = true }
 criterion = { workspace = true }
 file-format = { workspace = true }
 infer = { workspace = true }
+magic = { workspace = true }
 mime_guess = { workspace = true }
 tokio = { workspace = true, features = ["full"] }
 

file_type/Cargo.toml

@@ -102,6 +102,37 @@ fn bench_lifecycle(criterion: &mut Criterion) -> anyhow::Result<()> {
         });
     });
 
+    //
+    // Comparison testing to the magic crate
+    //
+    #[cfg(target_os = "linux")]
+    {
+        let cookie = magic::Cookie::open(Default::default())?;
+        let cookie = cookie
+            .load(&Default::default())
+            .expect("failed to load magic database");
+
+        criterion.bench_function("magic::from_bytes", |bencher| {
+            bencher.iter(|| {
+                // human-readable description, more than a static name
+                cookie.set_flags(magic::cookie::Flags::ERROR).unwrap();
+                let _ = cookie.buffer(&bytes).unwrap();
+
+                // file type extensions
+                cookie
+                    .set_flags(magic::cookie::Flags::ERROR | magic::cookie::Flags::EXTENSION)
+                    .unwrap();
+                let _ = cookie.buffer(&bytes).unwrap();
+
+                // media type
+                cookie
+                    .set_flags(magic::cookie::Flags::ERROR | magic::cookie::Flags::MIME_TYPE)
+                    .unwrap();
+                let _ = cookie.buffer(&bytes).unwrap();
+            });
+        });
+    }
+
     //
     // Comparison testing to the mime_guess crate
     //