Struct EvaluationContext 

pub struct EvaluationContext { /* private fields */ }

Context for maintaining evaluation state during rule processing

The EvaluationContext tracks the current state of rule evaluation, including the current offset position, recursion depth for nested rules, and configuration settings that control evaluation behavior.

Examples

use libmagic_rs::evaluator::EvaluationContext;
use libmagic_rs::EvaluationConfig;

let config = EvaluationConfig::default();
let context = EvaluationContext::new(config);

assert_eq!(context.current_offset(), 0);
assert_eq!(context.recursion_depth(), 0);

Implementations

impl EvaluationContext

pub const fn new(config: EvaluationConfig) -> Self

Create a new evaluation context with the given configuration

Arguments

• config - Configuration settings for evaluation behavior

Examples

use libmagic_rs::evaluator::EvaluationContext;
use libmagic_rs::EvaluationConfig;

let config = EvaluationConfig::default();
let context = EvaluationContext::new(config);

pub const fn current_offset(&self) -> usize

Get the current offset position

Returns

The current offset position in the file buffer

pub fn set_current_offset(&mut self, offset: usize)

Set the current offset position

Arguments

• offset - The new offset position

pub const fn recursion_depth(&self) -> u32

Get the current recursion depth

Returns

The current recursion depth for nested rule evaluation

pub fn increment_recursion_depth(&mut self) -> Result<(), LibmagicError>

Increment the recursion depth

Returns

Ok(()) if the recursion depth is within limits, or Err(LibmagicError) if the maximum recursion depth would be exceeded

Errors

Returns LibmagicError::EvaluationError if incrementing would exceed the maximum recursion depth configured in the evaluation config.

pub fn decrement_recursion_depth(&mut self) -> Result<(), LibmagicError>

Decrement the recursion depth

Errors

Returns an error if the recursion depth is already 0, as this indicates a programming error in the evaluation logic (mismatched increment/decrement calls).

pub const fn config(&self) -> &EvaluationConfig

Get a reference to the evaluation configuration

Returns

A reference to the EvaluationConfig used by this context

pub const fn should_stop_at_first_match(&self) -> bool

Check if evaluation should stop at the first match

Returns

true if evaluation should stop at the first match, false otherwise

pub const fn max_string_length(&self) -> usize

Get the maximum string length allowed

Returns

The maximum string length that should be read during evaluation

pub const fn enable_mime_types(&self) -> bool

Check if MIME type mapping is enabled

Returns

true if MIME type mapping should be performed, false otherwise

pub const fn timeout_ms(&self) -> Option<u64>

Get the evaluation timeout in milliseconds

Returns

The timeout duration in milliseconds, or None if no timeout is set

pub fn reset(&mut self)

Reset the context to initial state while preserving configuration

This resets the current offset and recursion depth to 0, but keeps the same configuration settings.

Trait Implementations

impl Clone for EvaluationContext

fn clone(&self) -> EvaluationContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EvaluationContext

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

Formats the value using the given formatter.