Struct Page 

#[non_exhaustive]
pub struct Page {

    pub page_number: i32,
    pub image: Option<Image>,
    pub transforms: Vec<Matrix>,
    pub dimension: Option<Dimension>,
    pub layout: Option<Layout>,
    pub detected_languages: Vec<DetectedLanguage>,
    pub blocks: Vec<Block>,
    pub paragraphs: Vec<Paragraph>,
    pub lines: Vec<Line>,
    pub tokens: Vec<Token>,
    pub visual_elements: Vec<VisualElement>,
    pub tables: Vec<Table>,
    pub form_fields: Vec<FormField>,
    pub symbols: Vec<Symbol>,
    pub detected_barcodes: Vec<DetectedBarcode>,
    pub image_quality_scores: Option<ImageQualityScores>,
    pub provenance: Option<Provenance>,
    /* private fields */
}

A page in a Document.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

page_number: i32

1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

image: Option<Image>

Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

transforms: Vec<Matrix>

Transformation matrices that were applied to the original document image to produce Page.image.

dimension: Option<Dimension>

Physical dimension of the page.

layout: Option<Layout>

Layout for the page.

detected_languages: Vec<DetectedLanguage>

A list of detected languages together with confidence.

blocks: Vec<Block>

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

paragraphs: Vec<Paragraph>

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

lines: Vec<Line>

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

tokens: Vec<Token>

A list of visually detected tokens on the page.

visual_elements: Vec<VisualElement>

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

tables: Vec<Table>

A list of visually detected tables on the page.

form_fields: Vec<FormField>

A list of visually detected form fields on the page.

symbols: Vec<Symbol>

A list of visually detected symbols on the page.

detected_barcodes: Vec<DetectedBarcode>

A list of detected barcodes.

image_quality_scores: Option<ImageQualityScores>

Image quality scores.

provenance: Option<Provenance>

👎Deprecated

The history of this page.

Implementations

impl Page

pub fn new() -> Self

pub fn set_page_number<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_number.

pub fn set_image<T>(self, v: T) -> Self

where T: Into<Image>,

Sets the value of image.

pub fn set_or_clear_image<T>(self, v: Option<T>) -> Self

where T: Into<Image>,

Sets or clears the value of image.

pub fn set_transforms<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Matrix>,

Sets the value of transforms.

pub fn set_dimension<T>(self, v: T) -> Self

where T: Into<Dimension>,

Sets the value of dimension.

pub fn set_or_clear_dimension<T>(self, v: Option<T>) -> Self

where T: Into<Dimension>,

Sets or clears the value of dimension.

pub fn set_layout<T>(self, v: T) -> Self

where T: Into<Layout>,

Sets the value of layout.

pub fn set_or_clear_layout<T>(self, v: Option<T>) -> Self

where T: Into<Layout>,

Sets or clears the value of layout.

pub fn set_detected_languages<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<DetectedLanguage>,

Sets the value of detected_languages.

pub fn set_blocks<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Block>,

Sets the value of blocks.

pub fn set_paragraphs<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Paragraph>,

Sets the value of paragraphs.

pub fn set_lines<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Line>,

Sets the value of lines.

pub fn set_tokens<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Token>,

Sets the value of tokens.

pub fn set_visual_elements<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<VisualElement>,

Sets the value of visual_elements.

pub fn set_tables<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Table>,

Sets the value of tables.

pub fn set_form_fields<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<FormField>,

Sets the value of form_fields.

pub fn set_symbols<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Symbol>,

Sets the value of symbols.

pub fn set_detected_barcodes<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<DetectedBarcode>,

Sets the value of detected_barcodes.

pub fn set_image_quality_scores<T>(self, v: T) -> Self

where T: Into<ImageQualityScores>,

Sets the value of image_quality_scores.

pub fn set_or_clear_image_quality_scores<T>(self, v: Option<T>) -> Self

where T: Into<ImageQualityScores>,

Sets or clears the value of image_quality_scores.

pub fn set_provenance<T>(self, v: T) -> Self

where T: Into<Provenance>,

👎Deprecated

Sets the value of provenance.

pub fn set_or_clear_provenance<T>(self, v: Option<T>) -> Self

where T: Into<Provenance>,

👎Deprecated

Sets or clears the value of provenance.

Trait Implementations

impl Clone for Page

fn clone(&self) -> Page

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Page

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

Formats the value using the given formatter.

impl Default for Page

fn default() -> Page

Returns the “default value” for a type.

impl Message for Page

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Page

fn eq(&self, other: &Page) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Page