Skip to main content

Element

Enum Element 

Source
pub enum Element {
    Title(ElementData),
    Paragraph(ElementData),
    Table(TableElementData),
    Header(ElementData),
    Footer(ElementData),
    ListItem(ElementData),
    Image(ImageElementData),
    CodeBlock(ElementData),
    KeyValue(KeyValueElementData),
}
Expand description

A typed document element extracted from a PDF page.

Each variant carries its specific data plus shared ElementMetadata for page number, bounding box, confidence, and optional font info.

Variants§

Implementations§

Source§

impl Element

Source

pub fn text(&self) -> &str

Returns the primary text content of this element.

Source

pub fn display_text(&self) -> String

Returns a human-readable text representation of this element.

Unlike text() which returns raw content (empty for tables, value-only for KV pairs), this method produces a complete display form:

  • Tables: pipe-separated rows
  • Key-Value: “key: value”
  • All others: same as text()
Source

pub fn page(&self) -> u32

Returns the page number (0-indexed) where this element appears.

Source

pub fn bbox(&self) -> &ElementBBox

Returns the bounding box of this element on the page.

Source

pub fn metadata(&self) -> &ElementMetadata

Returns the full metadata for this element.

Source

pub fn metadata_mut(&mut self) -> &mut ElementMetadata

Returns a mutable reference to the metadata of this element.

Source

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

Returns the snake_case type name of this element variant.

Useful for logging, serialization, and metadata tagging. Returns one of: "title", "paragraph", "table", "header", "footer", "list_item", "image", "code_block", "key_value".

Source

pub fn set_parent_heading(&mut self, heading: Option<String>)

Set the parent heading for this element.

Source

pub fn set_heading_path(&mut self, path: Vec<String>)

Set the full heading breadcrumb for this element.

Source

pub fn row_count(&self) -> Option<usize>

Returns the number of rows if this is a Table element.

Source

pub fn column_count(&self) -> Option<usize>

Returns the number of columns if this is a Table element.

Source

pub fn cell(&self, row: usize, col: usize) -> Option<&str>

Returns the cell text at (row, col) if this is a Table element.

Trait Implementations§

Source§

impl Clone for Element

Source§

fn clone(&self) -> Element

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Element

Source§

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

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

impl Eq for Element

Source§

impl PartialEq for Element

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

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> Same for T

Source§

type Output = T

Should always be Self
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 = !

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<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