Skip to main content

ContentLayers

Struct ContentLayers 

Source
pub struct ContentLayers {
    pub body: bool,
    pub furniture: bool,
    pub notes: bool,
    pub invisible: bool,
}
Expand description

A set of content layers, body included — docling-core’s set[ContentLayer] (HTMLParams.layers, export_to_html(included_content_layers=…)), where body is a member like any other. Default is docling’s DEFAULT_CONTENT_LAYERS: body only, so an export built with it is unchanged from before layers could be chosen (#499).

Fields§

§body: bool

The main content (items without an explicit layer).

§furniture: bool

ContentLayer::Furniture: page headers/footers, navigation chrome.

§notes: bool

ContentLayer::Notes: reviewer comments and other editorial notes.

§invisible: bool

ContentLayer::Invisible: hidden content (hidden sheets, …).

Implementations§

Source§

impl ContentLayers

Source

pub const BODY: Self

Body only — docling’s DEFAULT_CONTENT_LAYERS.

Source

pub const ALL: Self

Every layer — Python’s set(ContentLayer).

Source

pub const NONE: Self

No layer at all (nothing renders); build a set from it with with / with_body.

Source

pub const fn with(self, layer: ContentLayer) -> Self

The set plus layer.

Source

pub const fn with_body(self) -> Self

The set plus the body layer.

Source

pub fn contains(&self, layer: Option<ContentLayer>) -> bool

Whether layer is in the set; None is the body layer.

Source

pub fn contains_name(&self, name: &str) -> bool

Whether the layer spelled name (body, furniture, notes, invisible — the JSON content_layer values) is in the set; an unknown name is not.

Source

pub fn parse_list(list: &str) -> Result<Self, String>

Parse a comma-separated list of layer names (body,furniture; whitespace around a name is ignored, all is every layer). An unknown name is the error. docling-core 2.99’s background layer (watermarks) has no items in this model, so the name is accepted and adds nothing — a set written for Python keeps parsing.

Trait Implementations§

Source§

impl Clone for ContentLayers

Source§

fn clone(&self) -> Self

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 ContentLayers

Source§

impl Debug for ContentLayers

Source§

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

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

impl Default for ContentLayers

Source§

fn default() -> Self

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

impl Eq for ContentLayers

Source§

impl Hash for ContentLayers

Source§

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

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 ContentLayers

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

impl StructuralPartialEq for ContentLayers

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.