Struct MagicDb

Source

pub struct MagicDb { /* private fields */ }

Expand description

Represents a database of MagicRule

Implementations§

Source §

impl MagicDb

Source

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

Source

pub fn new() -> Self

Creates a new empty database

§Returns

MagicDb - A new empty database

Source

pub fn load(&mut self, ms: MagicSource) -> &mut Self

Loads rules from a MagicSource

§Arguments

ms - The MagicSource to load rules from

Source

pub fn load_bulk<I: Iterator<Item = MagicSource>>(&mut self, it: I) -> &mut Self

Loads multiple MagicSource items efficiently in bulk.

This is more efficient than loading each individually. After processing all sources, it applies finalization step only once.

Source

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

Gets all rules in the database

§Returns

&[MagicRule] - A slice of all rules

Source

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

§Warning

File extension acceleration is made to evaluate rules faster by testing first the rules defining this extension with an !:ext entry. Whether you use extension acceleration or not with this function should not produce different results. Yet this makes the assumption rules are written correctly and every rule concerned defines !:ext when it is appropriate. If some rules are missing it, results might differ.

Source

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

§Warning

File extension acceleration is made to evaluate rules faster by testing first the rules defining this extension with an !:ext entry. Whether you use extension acceleration or not with this function should not produce different results. Yet this makes the assumption rules are written correctly and every rule concerned defines !:ext when it is appropriate. If some rules are missing it, results might differ.

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn verify(&mut self) -> Result<(), Error>

Verifies the consistency of the MagicDb database. This method must be called when the database is built once and used later. It catches Error that would raise at rule evaluation time.