Skip to main content

OcrEngine

Struct OcrEngine 

Source
pub struct OcrEngine { /* private fields */ }
Expand description

A loaded, warm OCR engine.

Build once on a dedicated worker thread; reuse across slides. DirectML sessions are GPU-state-bound — keep on the same thread.

Implementations§

Source§

impl OcrEngine

Source

pub fn load(model_dir: &Path) -> Result<Self, OcrError>

Load using OcrArtifactManifest::pp_ocr_v6, the digest-pinned model set with resolved provenance.

Source

pub fn load_with_manifest( model_dir: &Path, manifest: &OcrArtifactManifest, ) -> Result<Self, OcrError>

Load det + rec sessions from an explicit, verified model directory.

Probes DirectML first on Windows and records any CPU fallback.

Expected files:

  • <model_dir>/det.onnx detector ONNX
  • <model_dir>/rec.onnx recognizer ONNX
  • <model_dir>/en_dict.txt character dictionary (UTF-8, one char/line)
Source

pub fn load_with_lease( model_dir: &Path, manifest: &OcrArtifactManifest, lease_hook: Option<&dyn ModelLeaseHook>, ) -> Result<Self, OcrError>

Like OcrEngine::load_with_manifest, taking a model-store lease first.

The hook is called before any artifact is verified, so an app’s model GC cannot replace the payload between verification and session construction. The returned guard is held until the engine is dropped (after its sessions).

Source

pub fn validate_sessions( model_dir: &Path, manifest: &OcrArtifactManifest, ) -> Result<(), OcrError>

Verify model_dir against manifest, then build and drop real det + rec sessions.

For migration and doctor checks that already hold the app’s model lease, so none is taken here. Native-only OCR callers never need this.

Source

pub fn provider_diagnostics(&self) -> &[ProviderDiagnostic]

Source

pub fn run(&mut self, img: &RgbImage) -> Result<String, OcrError>

OCR a pre-loaded RGB image; returns newline-joined text.

Source

pub fn run_lines(&mut self, img: &RgbImage) -> Result<Vec<OcrLine>, OcrError>

OCR with per-line geometry: one OcrLine per visual line, rect = union of the line’s detected boxes normalized to the image (top-left origin), confidence = mean CTC character score when the recognizer emits probabilities.

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.