rust-magic

libmagic bindings for Rust.

Usage

This magic crate is published on the crates.io Rust package registry.

Use cargo add to specify dependencies:

$ cargo add magic

You might be familiar with libmagic's CLI; file:

$ file data/tests/rust-logo-128x128-blk.png
data/tests/rust-logo-128x128-blk.png: PNG image data, 128 x 128, 8-bit/color RGBA, non-interlaced

You can implement something similar in Rust with the magic crate (see examples/file-ish.rs):

fn file_example() -> Result<(), magic::MagicError> {
    // Open a new configuration with flags
    let cookie = magic::Cookie::open(magic::CookieFlags::ERROR)?;

    // Load a specific database (so exact text assertion below works regardless of the system's default database)
    cookie.load(&["data/tests/db-images-png"])?;

    let file = "data/tests/rust-logo-128x128-blk.png";

    // Analyze the file
    assert_eq!(cookie.file(file)?, "PNG image data, 128 x 128, 8-bit/color RGBA, non-interlaced");

    Ok(())
}

$ cargo run --example file-ish -- data/tests/rust-logo-128x128-blk.png
PNG image data, 128 x 128, 8-bit/color RGBA, non-interlaced

Read the magic rustdoc for further examples and info.

MSRV

The Minimum Supported Rust Version (MSRV) is Rust 1.56 or higher.

This version might be changed in the future, but it will be done with a crate version bump.

Requirements

By default, compiling the magic crate will search your system library paths for a shared library version of libmagic to link against. For this to work, you need to install the development version of libmagic in a standard location:

$ # On Debian based Linux systems:
$ sudo apt-get install libmagic1 libmagic-dev

$ # On MacOs:
$ brew install libmagic

$ # On Windows:
$ cargo install cargo-vcpkg
$ cargo vcpkg build

If you're cross-compiling, or need more control over which library is selected, see how to build magic-sys.

License

This project is licensed under either of

• Apache License, Version 2.0 (LICENSES/Apache-2.0.txt or https://opensource.org/licenses/Apache-2.0)
• MIT license (LICENSES/MIT.txt or https://opensource.org/licenses/MIT)

at your option.

For further details, see LICENSE.md.

Security

See SECURITY.md.

Contribution

See CONTRIBUTING.md.