Skip to main content

ParsedHeading

Struct ParsedHeading 

Source
pub struct ParsedHeading<'a> {
    pub line_num: usize,
    pub heading: &'a HeadingInfo,
    pub line_info: &'a LineInfo,
    pub blockquote_depth: usize,
}
Expand description

A heading recognized in the rendered Markdown document.

Unlike ValidHeading, this view includes headings inside blockquotes and malformed ATX headings retained for diagnostics such as MD018. Consumers can select the semantics they need without reparsing source lines.

Fields§

§line_num: usize

The 1-indexed line number in the document.

§heading: &'a HeadingInfo

Parsed heading metadata.

§line_info: &'a LineInfo

Full source-line metadata.

§blockquote_depth: usize

Blockquote nesting depth, or zero for a top-level heading.

Implementations§

Source§

impl ParsedHeading<'_>

Source

pub fn is_blockquote(&self) -> bool

Whether this heading is inside a blockquote.

Source

pub fn is_setext(&self) -> bool

Whether this is a Setext-style heading.

Source

pub fn text_byte_range(&self, source: &str) -> (usize, usize)

Byte offsets (start, end) of the heading text within its source line.

Markers, closing ATX sequences, and custom-ID syntax are excluded. The range is line-relative so callers can convert it to their own position representation without rescanning Markdown syntax.

Trait Implementations§

Source§

impl<'a> Clone for ParsedHeading<'a>

Source§

fn clone(&self) -> ParsedHeading<'a>

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<'a> Copy for ParsedHeading<'a>

Source§

impl<'a> Debug for ParsedHeading<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for ParsedHeading<'a>

§

impl<'a> RefUnwindSafe for ParsedHeading<'a>

§

impl<'a> Send for ParsedHeading<'a>

§

impl<'a> Sync for ParsedHeading<'a>

§

impl<'a> Unpin for ParsedHeading<'a>

§

impl<'a> UnsafeUnpin for ParsedHeading<'a>

§

impl<'a> UnwindSafe for ParsedHeading<'a>

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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