Skip to main content

LayoutElementType

Enum LayoutElementType 

Source
pub enum LayoutElementType {
Show 28 variants DocTitle, ParagraphTitle, Text, Content, Abstract, Image, Table, Chart, Formula, FigureTitle, TableTitle, ChartTitle, FigureTableChartTitle, Header, HeaderImage, Footer, FooterImage, Footnote, Seal, Number, Reference, ReferenceContent, Algorithm, FormulaNumber, AsideText, List, Region, Other,
}
Expand description

Layout element type supporting PP-StructureV3’s full label set.

This enum represents both semantic categories and fine-grained labels for layout elements. PP-StructureV3 models output 20 or 23 class labels depending on the model variant.

The original model-specific label is preserved in LayoutElement.label field.

§PP-StructureV3 Label Categories

Document structure:

  • DocTitle - Document title (doc_title)
  • ParagraphTitle - Section/paragraph title (paragraph_title)
  • Text - General text content
  • Content - Table of contents (content)
  • Abstract - Abstract section

Visual elements:

  • Image - Images/figures (image, figure)
  • Table - Tables
  • Chart - Charts/graphs
  • Formula - Mathematical formulas

Captions and titles:

  • FigureTitle - Figure caption (figure_title)
  • TableTitle - Table caption (table_title)
  • ChartTitle - Chart caption (chart_title)
  • FigureTableChartTitle - Combined caption type

Page structure:

  • Header - Page header
  • HeaderImage - Header image
  • Footer - Page footer
  • FooterImage - Footer image
  • Footnote - Footnotes

Special elements:

  • Seal - Stamps/official seals

  • Number - Page numbers

  • Reference - References section

  • ReferenceContent - Reference content

  • Algorithm - Algorithm blocks

  • FormulaNumber - Formula numbers

  • AsideText - Marginal/aside text

  • List - List items

  • Other - Unknown/unmapped labels

Variants§

§

DocTitle

Document title

§

ParagraphTitle

Paragraph/section title

§

Text

General text content

§

Content

Table of contents

§

Abstract

Abstract section

§

Image

Image or figure

§

Table

Table

§

Chart

Chart or graph

§

Formula

Mathematical formula

§

FigureTitle

Figure caption/title

§

TableTitle

Table caption/title

§

ChartTitle

Chart caption/title

§

FigureTableChartTitle

Combined figure/table/chart title (PP-DocLayout)

§

Header

Page header

§

HeaderImage

Header image

§

Footer

Page footer

§

FooterImage

Footer image

§

Footnote

Footnote

§

Seal

Stamp or official seal

§

Number

Page number

§

Reference

Reference section

§

ReferenceContent

Reference content (PP-DocLayout_plus-L)

§

Algorithm

Algorithm block

§

FormulaNumber

Formula number

§

AsideText

Marginal/aside text

§

List

List items

§

Region

Generic document region block (PP-DocBlockLayout) Used for hierarchical layout ordering and block grouping

§

Other

Other/unknown (original label preserved in LayoutElement.label)

Implementations§

Source§

impl LayoutElementType

Source

pub fn as_str(&self) -> &'static str

Returns the string representation of the element type.

This returns the PP-StructureV3 compatible label string.

Source

pub fn from_label(label: &str) -> LayoutElementType

Creates a LayoutElementType from a string label with fine-grained mapping.

This method maps model output labels to their corresponding fine-grained types, preserving the full PP-StructureV3 label set (20/23 classes).

Source

pub fn semantic_category(&self) -> &'static str

Returns the semantic category for this element type.

This method groups fine-grained types into broader semantic categories, useful for processing logic that doesn’t need fine-grained distinctions.

§Categories
  • Title: DocTitle, ParagraphTitle
  • Text: Text, Content, Abstract
  • Visual: Image, Chart
  • Table: Table
  • Caption: FigureTitle, TableTitle, ChartTitle, FigureTableChartTitle
  • Header: Header, HeaderImage
  • Footer: Footer, FooterImage, Footnote
  • Formula: Formula, FormulaNumber
  • Special: Seal, Number, Reference, ReferenceContent, Algorithm, AsideText
  • List: List
  • Other: Other
Source

pub fn is_title(&self) -> bool

Returns whether this element type is a title variant.

Source

pub fn is_visual(&self) -> bool

Returns whether this element type is a visual element (image, chart, figure).

Source

pub fn is_caption(&self) -> bool

Returns whether this element type is a caption variant.

Source

pub fn is_header(&self) -> bool

Returns whether this element type is a header variant.

Returns whether this element type is a footer variant.

Source

pub fn is_formula(&self) -> bool

Returns whether this element type is a formula variant.

Source

pub fn should_ocr(&self) -> bool

Returns whether this element type contains text content that should be OCR’d.

Trait Implementations§

Source§

impl Clone for LayoutElementType

Source§

fn clone(&self) -> LayoutElementType

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LayoutElementType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for LayoutElementType

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<LayoutElementType, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for LayoutElementType

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for LayoutElementType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for LayoutElementType

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for LayoutElementType

Source§

impl Eq for LayoutElementType

Source§

impl StructuralPartialEq for LayoutElementType

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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<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> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,