Skip to main content

EvaluationMetadata

Struct EvaluationMetadata 

Source
#[non_exhaustive]
pub struct EvaluationMetadata { pub file_size: u64, pub evaluation_time_ms: f64, pub rules_evaluated: usize, pub magic_file: Option<PathBuf>, pub timed_out: bool, }
Expand description

Metadata about the evaluation process

Contains diagnostic information about how the evaluation was performed, including performance metrics and statistics about rule processing.

§Examples

use libmagic_rs::EvaluationMetadata;
use std::path::PathBuf;

let metadata = EvaluationMetadata::new(
    8192,
    2.5,
    42,
    Some(PathBuf::from("/usr/share/misc/magic")),
    false,
);

assert_eq!(metadata.file_size, 8192);
assert!(!metadata.timed_out);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§file_size: u64

Size of the analyzed file or buffer in bytes

§evaluation_time_ms: f64

Time taken to evaluate rules in milliseconds

§rules_evaluated: usize

Number of top-level rules that were evaluated

§magic_file: Option<PathBuf>

Path to the magic file used, or None for built-in rules

§timed_out: bool

Whether evaluation was stopped due to timeout

Implementations§

Source§

impl EvaluationMetadata

Source

pub fn new( file_size: u64, evaluation_time_ms: f64, rules_evaluated: usize, magic_file: Option<PathBuf>, timed_out: bool, ) -> Self

Construct a new library-side EvaluationMetadata from the four always-set fields. magic_file and timed_out default to None / false; use struct-update syntax with EvaluationMetadata::default() to set them explicitly.

Trait Implementations§

Source§

impl Clone for EvaluationMetadata

Source§

fn clone(&self) -> EvaluationMetadata

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EvaluationMetadata

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EvaluationMetadata

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Serialize for EvaluationMetadata

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.