Skip to main content

DocumentMetadata

html_to_markdown_rs::metadata

Struct DocumentMetadata

pub struct DocumentMetadata {
    pub title: Option<String>,
    pub description: Option<String>,
    pub keywords: Vec<String>,
    pub author: Option<String>,
    pub canonical_url: Option<String>,
    pub base_href: Option<String>,
    pub language: Option<String>,
    pub text_direction: Option<TextDirection>,
    pub open_graph: BTreeMap<String, String>,
    pub twitter_card: BTreeMap<String, String>,
    pub meta_tags: BTreeMap<String, String>,
}

Expand description

Document-level metadata extracted from <head> and top-level elements.

Contains all metadata typically used by search engines, social media platforms, and browsers for document indexing and presentation.

§Examples

let doc = DocumentMetadata {
    title: Some("My Article".to_string()),
    description: Some("A great article about Rust".to_string()),
    keywords: vec!["rust".to_string(), "programming".to_string()],
    ..Default::default()
};

assert_eq!(doc.title, Some("My Article".to_string()));

Fields§

§title: Option<String>

Document title from <title> tag

§description: Option<String>

Document description from <meta name="description"> tag

§keywords: Vec<String>

Document keywords from <meta name="keywords"> tag, split on commas

§author: Option<String>

Document author from <meta name="author"> tag

§canonical_url: Option<String>

Canonical URL from <link rel="canonical"> tag

§base_href: Option<String>

Base URL from <base href=""> tag for resolving relative URLs

§language: Option<String>

Document language from lang attribute

§text_direction: Option<TextDirection>

Document text direction from dir attribute

§open_graph: BTreeMap<String, String>

Open Graph metadata (og:* properties) for social media Keys like “title”, “description”, “image”, “url”, etc.

§twitter_card: BTreeMap<String, String>

Twitter Card metadata (twitter:* properties) Keys like “card”, “site”, “creator”, “title”, “description”, “image”, etc.

§meta_tags: BTreeMap<String, String>

Additional meta tags not covered by specific fields Keys are meta name/property attributes, values are content

Trait Implementations§

impl Clone for DocumentMetadata

fn clone(&self) -> DocumentMetadata

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

impl Debug for DocumentMetadata

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

Formats the value using the given formatter. Read more

impl Default for DocumentMetadata

fn default() -> DocumentMetadata

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

impl<'de> Deserialize<'de> for DocumentMetadata

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

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for DocumentMetadata

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for DocumentMetadata

impl RefUnwindSafe for DocumentMetadata

impl Send for DocumentMetadata

impl Sync for DocumentMetadata

impl Unpin for DocumentMetadata

impl UnwindSafe for DocumentMetadata

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,