Struct HeaderMetadata 

pub struct HeaderMetadata {
    pub level: u8,
    pub text: String,
    pub id: Option<String>,
    pub depth: usize,
    pub html_offset: usize,
}

Header element metadata with hierarchy tracking.

Captures heading elements (h1-h6) with their text content, identifiers, and position in the document structure.

Examples

let header = HeaderMetadata {
    level: 1,
    text: "Main Title".to_string(),
    id: Some("main-title".to_string()),
    depth: 0,
    html_offset: 145,
};

assert_eq!(header.level, 1);
assert!(header.is_valid());

Fields

level: u8

Header level: 1 (h1) through 6 (h6)

text: String

Normalized text content of the header

id: Option<String>

HTML id attribute if present

depth: usize

Document tree depth at the header element

html_offset: usize

Byte offset in original HTML document

Implementations

impl HeaderMetadata

pub fn is_valid(&self) -> bool

Validate that the header level is within valid range (1-6).

Returns

true if level is 1-6, false otherwise.

Examples

let valid = HeaderMetadata {
    level: 3,
    text: "Title".to_string(),
    id: None,
    depth: 2,
    html_offset: 100,
};
assert!(valid.is_valid());

let invalid = HeaderMetadata {
    level: 7,  // Invalid
    text: "Title".to_string(),
    id: None,
    depth: 2,
    html_offset: 100,
};
assert!(!invalid.is_valid());

Trait Implementations

impl Clone for HeaderMetadata

fn clone(&self) -> HeaderMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HeaderMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HeaderMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.