Skip to main content

RuleContext

Struct RuleContext 

Source
pub struct RuleContext {
    pub marking_type: MarkingType,
    pub zone: Option<Zone>,
    pub position: Option<DocumentPosition>,
    pub page_context: Option<Arc<PageContext>>,
    pub corrections: Option<Arc<HashMap<String, String>>>,
}
Expand description

Document position context passed to rules alongside parsed markings.

Phase 3 made zone and position Option-typed: the scanner cannot reliably determine header/footer/body or document position from raw text alone, so a rule that reads either field must handle None. They will become populated in a future scanner pass that consumes document structural metadata (page count, line numbers, header/footer detection on extracted documents).

page_context is populated by the engine for every non-portion candidate (Banner, CAB) so banner-validation rules can compare the observed banner against the composite expected from all preceding portions. The engine resets it at scanner-emitted MarkingType::PageBreak candidates (form-feed \f and \n\n\n+ heuristics) so the context reflects only the current page.

Fields§

§marking_type: MarkingType§zone: Option<Zone>

Document zone (header/footer/body/CAB) when known. None in Phase 3 — the scanner cannot prove header vs footer from raw text.

§position: Option<DocumentPosition>

Coarse document position when known. None in Phase 3.

§page_context: Option<Arc<PageContext>>

Accumulated portion data for the current page, reset at every scanner-emitted MarkingType::PageBreak.

§corrections: Option<Arc<HashMap<String, String>>>

Organization-specific corrections map from config [corrections]. None when no corrections are configured.

Trait Implementations§

Source§

impl Clone for RuleContext

Source§

fn clone(&self) -> RuleContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RuleContext

Source§

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

Formats the value using the given formatter. 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.