Struct OcrEngine 

pub struct OcrEngine { /* private fields */ }

OCR engine

Encapsulates complete OCR pipeline, including text detection and recognition

Example

use ocr_rs::{OcrEngine, OcrEngineConfig};

// Create engine
let engine = OcrEngine::new(
    "det_model.mnn",
    "rec_model.mnn",
    "ppocr_keys.txt",
    None,
)?;

// Recognize image
let image = image::open("test.jpg")?;
let results = engine.recognize(&image)?;

for result in results {
    println!("{}: {:.2}", result.text, result.confidence);
}

Implementations

impl OcrEngine

pub fn new( det_model_path: impl AsRef<Path>, rec_model_path: impl AsRef<Path>, charset_path: impl AsRef<Path>, config: Option<OcrEngineConfig>, ) -> OcrResult<Self>

Create OCR engine from model files

Parameters

• det_model_path: Detection model file path
• rec_model_path: Recognition model file path
• charset_path: Charset file path
• config: Optional engine configuration

pub fn new_with_ori( det_model_path: impl AsRef<Path>, rec_model_path: impl AsRef<Path>, charset_path: impl AsRef<Path>, ori_model_path: impl AsRef<Path>, config: Option<OcrEngineConfig>, ) -> OcrResult<Self>

Create OCR engine from model files with orientation model

pub fn from_bytes( det_model_bytes: &[u8], rec_model_bytes: &[u8], charset_bytes: &[u8], config: Option<OcrEngineConfig>, ) -> OcrResult<Self>

Create OCR engine from model bytes

pub fn from_bytes_with_ori( det_model_bytes: &[u8], rec_model_bytes: &[u8], charset_bytes: &[u8], ori_model_bytes: &[u8], config: Option<OcrEngineConfig>, ) -> OcrResult<Self>

Create OCR engine from model bytes with orientation model

pub fn det_only( det_model_path: impl AsRef<Path>, config: Option<OcrEngineConfig>, ) -> OcrResult<DetOnlyEngine>

Create detection-only engine

pub fn rec_only( rec_model_path: impl AsRef<Path>, charset_path: impl AsRef<Path>, config: Option<OcrEngineConfig>, ) -> OcrResult<RecOnlyEngine>

Create recognition-only engine

pub fn recognize(&self, image: &DynamicImage) -> OcrResult<Vec<OcrResult_>>

Perform complete OCR recognition

Parameters

• image: Input image

Returns

List of OCR results, each result contains text, confidence and bounding box

pub fn recognize_with_options( &self, image: &DynamicImage, options: &RecognizeOptions, ) -> OcrResult<Vec<OcrResult_>>

Perform OCR recognition with per-call options.

RotatedTextMode::Disabled is the default and runs the same one-pass pipeline as Self::recognize. RotatedTextMode::Robust performs two additional detection passes and only recognizes horizontal candidates from those rotated images, keeping the added recognition work small.

pub fn detect(&self, image: &DynamicImage) -> OcrResult<Vec<TextBox>>

Perform detection only

pub fn recognize_text( &self, image: &DynamicImage, ) -> OcrResult<RecognitionResult>

Perform recognition only (requires pre-cropped text line images)

pub fn recognize_batch( &self, images: &[DynamicImage], ) -> OcrResult<Vec<RecognitionResult>>

Batch recognize text line images

pub fn ori_model(&self) -> Option<&OriModel>

Get orientation model reference (if enabled)

pub fn det_model(&self) -> &DetModel

Get detection model reference

pub fn rec_model(&self) -> &RecModel

Get recognition model reference

pub fn config(&self) -> &OcrEngineConfig

Get configuration