Trait TaskDefinition 

pub trait TaskDefinition:
    Send
    + Sync
    + Clone
    + Debug
    + 'static {
    const TASK_NAME: &'static str;
    const TASK_DOC: &'static str;

    // Required method
    fn empty() -> Self;
}

Trait for compile-time task registration.

Implemented by each task’s output type to provide metadata for enum generation and dynamic dispatch. The trait constants feed the task registry macros that generate documentation and helper methods.

Example

use oar_ocr_core::core::traits::TaskDefinition;

#[derive(Debug, Clone)]
pub struct MyTaskOutput {
    pub results: Vec<String>,
}

impl TaskDefinition for MyTaskOutput {
    const TASK_NAME: &'static str = "my_task";
    const TASK_DOC: &'static str = "My custom task for processing data";

    fn empty() -> Self {
        Self { results: Vec::new() }
    }
}

Required Associated Constants

const TASK_NAME: &'static str

Snake_case name for the task (e.g., “text_detection”).

Used by TaskType::name() to return a human-readable identifier.

const TASK_DOC: &'static str

Human-readable documentation for the task.

Used to generate doc comments on enum variants.

Required Methods

fn empty() -> Self

Creates an empty output instance.

Used for default values, testing, and by DynTaskOutput::empty_for().

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl TaskDefinition for DocumentOrientationOutput

const TASK_NAME: &'static str = "document_orientation"

const TASK_DOC: &'static str = "Document orientation classification"

impl TaskDefinition for DocumentRectificationOutput

const TASK_NAME: &'static str = "document_rectification"

const TASK_DOC: &'static str = "Document rectification/unwarp"

impl TaskDefinition for FormulaRecognitionOutput

const TASK_NAME: &'static str = "formula_recognition"

const TASK_DOC: &'static str = "Formula recognition - converting mathematical formulas to LaTeX"

impl TaskDefinition for LayoutDetectionOutput

const TASK_NAME: &'static str = "layout_detection"

const TASK_DOC: &'static str = "Layout detection/analysis"

impl TaskDefinition for SealTextDetectionOutput

const TASK_NAME: &'static str = "seal_text_detection"

const TASK_DOC: &'static str = "Seal text detection - locating text regions in seal/stamp images"

impl TaskDefinition for TableCellDetectionOutput

const TASK_NAME: &'static str = "table_cell_detection"

const TASK_DOC: &'static str = "Table cell detection - locating cells within table regions"

impl TaskDefinition for TableClassificationOutput

const TASK_NAME: &'static str = "table_classification"

const TASK_DOC: &'static str = "Table classification - classifying table images as wired or wireless"

impl TaskDefinition for TableStructureRecognitionOutput

const TASK_NAME: &'static str = "table_structure_recognition"

const TASK_DOC: &'static str = "Table structure recognition - recognizing table structure as HTML with bboxes"

impl TaskDefinition for TextDetectionOutput

const TASK_NAME: &'static str = "text_detection"

const TASK_DOC: &'static str = "Text detection - locating text regions in images"

impl TaskDefinition for TextLineOrientationOutput

const TASK_NAME: &'static str = "text_line_orientation"

const TASK_DOC: &'static str = "Text line orientation classification"

impl TaskDefinition for TextRecognitionOutput

const TASK_NAME: &'static str = "text_recognition"

const TASK_DOC: &'static str = "Text recognition - converting text regions to strings"