Section

Struct Section 

Source
pub struct Section {
    pub id: Option<String>,
    pub section_type: Option<String>,
    pub label: Option<String>,
    pub title: Option<String>,
    pub content: String,
    pub subsections: Vec<Section>,
    pub figures: Vec<Figure>,
    pub tables: Vec<Table>,
    pub formulas: Vec<Formula>,
    pub cited_reference_ids: Vec<String>,
}
Expand description

Article section.

Maps to JATS <sec>. Sections form a recursive tree via subsections. Figures, tables, and formulas that appear inline within the section are collected in their respective fields.

Fields§

§id: Option<String>

Section ID. From <sec id="...">.

§section_type: Option<String>

Section type. From <sec sec-type="...">. Common values: "intro", "methods", "results", "discussion", "conclusions", "supplementary-material", "data-availability".

§label: Option<String>

Section label/number (e.g., “1.”, “2.1”). From <label>.

§title: Option<String>

Section title. From <title>.

§content: String

Concatenated paragraph text. From <p> elements.

§subsections: Vec<Section>

Nested subsections. From child <sec> elements.

§figures: Vec<Figure>

Figures within this section. From <fig> elements.

§tables: Vec<Table>

Tables within this section. From <table-wrap> elements.

§formulas: Vec<Formula>

Display formulas within this section. From <disp-formula> elements.

§cited_reference_ids: Vec<String>

Reference ids cited in this section’s paragraphs, in document order. From <xref ref-type="bibr" rid="...">; each id targets a Reference::id in Back::references, so consumers can join the two for citation-context / citation-graph analysis. A grouped citation (rid="B1 B2") contributes each id separately.

Implementations§

Source§

impl Section

Source

pub fn kind(&self) -> SectionKind

Semantic classification of this section’s sec-type.

Source

pub fn iter_subtree(&self) -> SectionIter<'_> ⓘ

Iterate this section and all of its nested subsections, depth-first in document order (pre-order: parent before children).

Source

pub fn all_figures(&self) -> Vec<&Figure>

All figures in this section and its subsections (recursive).

Source

pub fn all_tables(&self) -> Vec<&Table>

All tables in this section and its subsections (recursive).

Source

pub fn all_formulas(&self) -> Vec<&Formula>

All display formulas in this section and its subsections (recursive).

Source

pub fn all_cited_reference_ids(&self) -> Vec<&String>

All cited reference ids in this section and its subsections (recursive), in document order. See Section::cited_reference_ids.

Source

pub fn word_count(&self) -> usize

Whitespace-delimited word count of this section’s own content (not including subsections). Useful for readability/length metrics.

Source

pub fn is_empty(&self) -> bool

Whether this section carries no text and no child structure.

Trait Implementations§

Source§

impl Clone for Section

Source§

fn clone(&self) -> Section

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 Section

Source§

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

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

impl<'de> Deserialize<'de> for Section

Source§

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

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

impl PartialEq for Section

Source§

fn eq(&self, other: &Section) -> 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 Section

Source§

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

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

impl StructuralPartialEq for Section

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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

impl<T> WithSubscriber for T

§

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
§

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