Struct filemagic::Magic

pub struct Magic { /* fields omitted */ }

Configuration of which Flags and magic databases to use

Implementations

impl Magic

pub fn error(&self) -> Option<String>

Returns a textual explanation of the last error, if any

You should not need to call this, since you can use the FileMagicError in the Result returned by the other functions.

pub fn file<P: AsRef<Path>>(
    &self,
    filename: P
) -> Result<String, FileMagicError>

Returns a textual description of the contents of the filename

pub fn buffer(&self, buffer: &[u8]) -> Result<String, FileMagicError>

Returns a textual description of the contents of the buffer

pub fn check<P: AsRef<Path>>(
    &self,
    filenames: &[P]
) -> Result<(), FileMagicError>

Check the validity of entries in the database filenames

pub fn compile<P: AsRef<Path>>(
    &self,
    filenames: &[P]
) -> Result<(), FileMagicError>

Compiles the given database filenames for faster access

The compiled files created are named from the basename of each file argument with '.mgc' appended to it.

pub fn list<P: AsRef<Path>>(
    &self,
    filenames: &[P]
) -> Result<(), FileMagicError>

Dumps all magic entries in the given database filenames in a human readable format

pub fn set_flags(&self, flags: Flags) -> bool

Sets the flags to use

Overwrites any previously set flags, e.g. those from load().

pub fn open(flags: Flags) -> Result<Magic, FileMagicError>

Creates a new configuration, flags specify how other functions should behave

This does not load() any databases yet.

pub fn load<P: AsRef<Path>>(
    &self,
    magic_databases: &[P]
) -> Result<(), FileMagicError>

Loads the given database filenames for further queries

Adds '.mgc' to the database files as appropriate.

Trait Implementations

impl Drop for Magic

pub fn drop(&mut self)

Closes the magic database and deallocates any resources used