Struct Magic 

pub struct Magic<'m> { /* private fields */ }

Represents a file magic detection result

Implementations

impl<'m> Magic<'m>

pub fn stream_kind(&self) -> Option<StreamKind>

Gets the detected StreamKind describing the type of detected data, or None if it was not determined.

Returns

• Option<StreamKind> - The detected kind or None

pub fn into_owned<'owned>(self) -> Magic<'owned>

Converts borrowed data into owned data. This method involves data cloning, so you must use this method only if you need to extend the lifetime of a Magic struct.

Returns

• Magic<'owned> - A new Magic with owned data

pub fn message(&self) -> String

Gets the formatted message describing the file type

Returns

• String - The formatted message

Note

The returned string only ever contains printable ASCII (graphic characters and spaces). Any other byte, including non-ASCII UTF-8 sequences, control characters and Unicode format/bidi characters, is escaped as \NNN (octal), the same way libmagic does. This makes the output safe to print directly to a terminal.

pub fn message_parts(&self) -> impl Iterator<Item = &str>

Returns an iterator over the individual raw parts of the magic message

A magic message is typically composed of multiple parts, each appended during successful magic tests. This method provides an efficient way to iterate over these parts without concatenating them into a new string, as done when calling Magic::message.

Returns

• impl Iterator<Item = &str> - An iterator yielding string slices of each message part

Note

Unlike Magic::message, the returned parts are not sanitized: they may contain raw control characters (e.g. ESC) extracted from the scanned data. Do not print them directly to a terminal, as this could result in terminal escape sequence injection. This method is intended for programmatic inspection only.

pub fn mime_type(&self) -> &str

Gets the detected MIME type

Returns

• &str - The MIME type or default based on stream kind

pub fn strength(&self) -> u64

Gets the confidence score of the detection. This value is used to sort Magic in MagicDb::best_magic and MagicDb::all_magics.

Returns

• u64 - The confidence score attributed to that Magic

pub fn source(&self) -> Option<&str>

Gets the filename where the magic rule was defined

Returns

• Option<&str> - The source if available

pub fn creator_code(&self) -> Option<&str>

Gets the Apple creator code if available

Returns

• Option<&str> - The creator code if available

pub fn extensions(&self) -> &HashSet<Cow<'m, str>>

Gets the possible file extensions for the detected Magic

Returns

• &HashSet<Cow<'m, str>> - The set of possible extensions

pub fn is_default(&self) -> bool

Checks if this is a default fallback detection

Returns

• bool - True if this is a default detection

Trait Implementations

impl<'m> Debug for Magic<'m>

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

Formats the value using the given formatter.

impl<'m> Default for Magic<'m>

fn default() -> Magic<'m>

Returns the “default value” for a type.