filemagic 0.13.1

libmagic bindings
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
106
107

filemagic-rs
-------------
![Crates.io](https://img.shields.io/crates/v/filemagic)
[![Documentation](https://docs.rs/filemagic/badge.svg)](https://docs.rs/filemagic)
[![Build Status](https://travis-ci.org/marirs/filemagic-rs.svg?branch=master)](https://travis-ci.org/marirs/filemagic-rs)

filemagic is a [Rust](http://www.rust-lang.org/) wrapper for [libmagic](http://darwinsys.com/file/), the library that supports the file command on most Unix systems. 
The package provides a simple [Rust](http://www.rust-lang.org/) API for identifying files using the extensive database of magic strings that ships with libmagic.
It can also load a custom database of magic strings.

### Requirements
- `Rust 1.40.0` or above stable version
- `libmagic` 
  - macOS: `brew install libmagic`
  - Linux: `apt install libmagic1 libmagic-dev`  

### Usage

Adding dependency to your `Cargo.toml` file
```toml
filemagic = "0.13.1"
```

## vendored

The `vendored` feature uses the [`cc` crate](https:/docs.rs/cc) to compile and
static link a vendored version of libmagic, currently based on 5.45.

Adding dependency to your `Cargo.toml` file
```toml
filemagic = { version = "0.13.1", features = ["vendored"] }
```

---
### Using Macros

- Using default libmagic database:
```rust
use filemagic::magic;

fn main() {
  let test_file_path = "/path/to/file";
  let magic = magic!().expect("error");
  
  println!("{}", magic.file(&test_file_path).expect("error"));
}
```

- Using custom Magic database:
```rust
use filemagic::magic;

fn main() {
  let test_file_path = "/path/to/file";
  let databases = vec!["data/db-images-png"];
  
  let magic = magic!(,&databases).expect("error");
  
  println!("{}", magic.file(&test_file_path).expect("error"));
}
```

---
### Using the function

- Using the default libmagic database:
```rust
use filemagic::Magic;

fn main() {
    let test_file_path = "/path/to/file";
    // Create a new default configuration
    let cookie = Magic::open(Default::default()).expect("error");
    cookie.load::<String>(&[]).expect("error");
    let magic = cookie.file(&test_file_path).expect("error in magic");
    println!("magic= {}", magic);
}
```

- Using custom Magic database:
```rust
use filemagic::Magic;

fn main() {
    // Create a new default configuration
    let cookie = Magic::open(Default::default()).expect("error");
    // Load one specific magic database
    let databases = vec!["data/db-images-png"];
    assert!(cookie.load(&databases).is_ok());

    // Recognize the magic of a test file
    let test_file_path = "data/rust-logo-128x128-blk.png";
    let expected_magic = "PNG image data, 128 x 128, 8-bit/color RGBA, non-interlaced";
    assert_eq!(cookie.file(&test_file_path).unwrap(), expected_magic);
}
```

---
### To generate the docs
```bash
cargo doc --release
```

---
References:
- robo9k [rust-magic](https://github.com/robo9k/rust-magic) & [rust-magic-sys](https://github.com/robo9k/rust-magic-sys)
- [Aaron Iles](https://github.com/aliles/filemagic)