Struct ExtractSession

Source

pub struct ExtractSession {Show 13 fields
    pub file_name: String,
    pub config: ProcessingConfig,
    pub author: Option<String>,
    pub title: Option<String>,
    pub creation_date: Option<String>,
    pub modification_date: Option<String>,
    pub number_of_pages: u32,
    pub page_contents: Vec<Vec<ContentElement>>,
    pub page_info_list: Vec<PageInfo>,
    pub mcid_map: McidMap,
    pub bookmarks: Vec<Bookmark>,
    pub candidates: Vec<RasterCandidate>,
    pub ocr_words: HashMap<u32, Vec<OcrWord>>,
}

Expand description

Intermediate state between extract (plan) and assemble (finish).

Fields§

§file_name: String

Display / document name.

§config: ProcessingConfig

Processing config snapshot.

§author: Option<String>

Author metadata.

§title: Option<String>

Title metadata.

§creation_date: Option<String>

Creation date metadata.

§modification_date: Option<String>

Modification date metadata.

§number_of_pages: u32

Page count.

§page_contents: Vec<Vec<ContentElement>>

Per-page content elements (tables not yet recovered from OCR candidates).

§page_info_list: Vec<PageInfo>

Page geometry.

§mcid_map: McidMap

Tagged PDF MCID map.

§bookmarks: Vec<Bookmark>

Bookmarks for heading refine.

§candidates: Vec<RasterCandidate>

OCR candidates (image feature).

§ocr_words: HashMap<u32, Vec<OcrWord>>

OCR words provided by the host, keyed by candidate id.

Implementations§

Source §

impl ExtractSession

Source

pub fn provide_ocr(&mut self, id: u32, words: Vec<OcrWord>)

Store host OCR words for a candidate (two-phase finish path).

Source

pub fn candidate_metas(&self) -> Vec<RasterCandidateMeta>

Candidate metadata list (no pixels).

Source

pub fn candidate_gray(&self, id: u32) -> Option<&[u8]>

Gray pixels for a candidate id.

Auto Trait Implementations§

§

impl UnwindSafe for ExtractSession

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §