Struct MagicDb 

pub struct MagicDb { /* private fields */ }

Represents a database of MagicRule

Implementations

impl MagicDb

pub fn optimal_lazy_cache<R: Read + Seek>(f: R) -> Result<LazyCache<R>, Error>

Prepares an LazyCache configured with optimal parameters for read operations done during file identification

pub fn new() -> Self

Creates a new empty database

Returns

• MagicDb - A new empty database

pub fn load(&mut self, mf: MagicSource) -> Result<&mut Self, Error>

Loads rules from a MagicSource

Arguments

• mf - The MagicSource to load rules from

Returns

• Result<&mut Self, Error> - Self for chaining or an error

pub fn rules(&self) -> &[MagicRule]

Gets all rules in the database

Returns

• &[MagicRule] - A slice of all rules

pub fn first_magic<R: Read + Seek>( &self, r: &mut R, extension: Option<&str>, ) -> Result<Magic<'_>, Error>

Detects file Magic stopping at the first matching magic. Magic rules are evaluated from the best to the least relevant, so this method returns most of the time the best magic. For the rare cases where it doesn’t or if the best result is always required, use MagicDb::best_magic

Arguments

• r - A readable and seekable input
• extension - Optional file extension to use for acceleration

Returns

• Result<Magic<'_>, Error> - The detection result or an error

pub fn first_magic_with_lazy_cache<R: Read + Seek>( &self, cache: &mut LazyCache<R>, extension: Option<&str>, ) -> Result<Magic<'_>, Error>

An alternative to Self::first_magic using a LazyCache to detects file Magic stopping at the first matching magic. Magic rules are evaluated from the best to the least relevant, so this method returns most of the time the best magic. For the rare cases where it doesn’t or if the best result is always required, use MagicDb::best_magic

Arguments

• cache - A LazyCache used for read operations
• extension - Optional file extension to use for acceleration

Returns

• Result<Magic<'_>, Error> - The detection result or an error

Notes

• Use this method only if you need to re-use a LazyCache for future read operations.
• Use Self::optimal_lazy_cache to prepare an optimal LazyCache

pub fn all_magics<R: Read + Seek>( &self, r: &mut R, ) -> Result<Vec<Magic<'_>>, Error>

Detects all Magic matching a given content.

Arguments

• r - A readable and seekable input

Returns

• Result<Vec<Magic<'_>>, Error> - All detection results sorted by strength or an error

pub fn all_magics_with_lazy_cache<R: Read + Seek>( &self, cache: &mut LazyCache<R>, ) -> Result<Vec<Magic<'_>>, Error>

An alternative to Self::all_magics using a LazyCache to detects all Magic matching a given content.

Arguments

• r - A readable and seekable input

Returns

• Result<Vec<Magic<'_>>, Error> - All detection results sorted by strength or an error

Notes

• Use this method only if you need to re-use a LazyCache for future read operations.
• Use Self::optimal_lazy_cache to prepare an optimal LazyCache

pub fn best_magic<R: Read + Seek>(&self, r: &mut R) -> Result<Magic<'_>, Error>

Detects the best Magic matching a given content.

Arguments

• r - A readable and seekable input

Returns

• Result<Magic<'_>, Error> - The best detection result or an error

pub fn best_magic_with_lazy_cache<R: Read + Seek>( &self, cache: &mut LazyCache<R>, ) -> Result<Magic<'_>, Error>

An alternative to Self::best_magic using a LazyCache to detect the best Magic matching a given content.

Arguments

• r - A readable and seekable input

Returns

• Result<Magic<'_>, Error> - The best detection result or an error

Notes

• Use this method only if you need to re-use a LazyCache for future read operations.
• Use Self::optimal_lazy_cache to prepare an optimal LazyCache

pub fn serialize<W: Write>(self, w: &mut W) -> Result<(), Error>

Serializes the database to a generic writer implementing io::Write

Returns

• Result<(), Error> - The serialized database or an error

pub fn deserialize<R: Read>(r: &mut R) -> Result<Self, Error>

Deserializes the database from a generic reader implementing io::Read

Arguments

• r - The reader to deserialize from

Returns

• Result<Self, Error> - The deserialized database or an error

Trait Implementations

impl Clone for MagicDb

fn clone(&self) -> MagicDb

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MagicDb

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MagicDb

fn default() -> MagicDb

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MagicDb

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MagicDb

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.