Skip to main content

CaptionParent

Enum CaptionParent 

Source
pub enum CaptionParent {
    Body,
    Container,
    ContainerAfter,
    Item,
}
Expand description

Where a picture’s or table’s caption text item hangs in the docling-JSON tree (#390). docling’s backends do not agree, and the JSON structure is the only surface that shows it (Markdown, DocLang and LaTeX place a caption by its item, whatever its parent): the PDF pipeline parents a layout caption to the picture or table it belongs to, while every declarative backend creates the caption with doc.add_text(label=CAPTION) and no parent — the document body — even when the item itself sits in a group or under a section header (JATS, LaTeX, HTML, Markdown, EPUB, AsciiDoc all do). The office backends hang a chart’s title caption off the chart’s container (the sheet group, the slide, docx’s current parent, docling#4190) — that is Node::Chart’s own path, not this choice. A backend that adds a new captioned item picks the variant matching upstream’s add_text call for that format; the default is upstream’s default.

Variants§

§

Body

#/body, listed after the enclosing top-level item — docling’s add_text default, which every declarative backend leaves alone.

§

Container

The item’s own container (its parent), listed ahead of the item: the caption is created first, as docling’s office backends do.

§

ContainerAfter

The item’s own container, listed after the item: docling’s HTML backend adds a <figure>-wrapped table, then its <figcaption> under self.parents[self.level] (docling#4050).

§

Item

The item itself — the caption is the picture’s or table’s first child, as docling’s PDF pipeline attaches a layout caption.

Trait Implementations§

Source§

impl Clone for CaptionParent

Source§

fn clone(&self) -> CaptionParent

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 Copy for CaptionParent

Source§

impl Debug for CaptionParent

Source§

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

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

impl Default for CaptionParent

Source§

fn default() -> CaptionParent

Returns the “default value” for a type. Read more
Source§

impl Eq for CaptionParent

Source§

impl PartialEq for CaptionParent

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CaptionParent

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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.