Skip to main content

HtmlReader

Struct HtmlReader 

Source
pub struct HtmlReader { /* private fields */ }
Expand description

A streaming HTML reader that implements EventSource.

HtmlReader parses HTML using html5gum and emits DocSpec events one at a time. Only <p> paragraph elements are recognized; all other elements are silently ignored.

§Example

use docspec_html_reader::{HtmlReader, EventSource};

let mut reader = HtmlReader::from_str("<p>hello</p>");
while let Some(event) = reader.next_event()? {
    // Process events...
}

Implementations§

Source§

impl HtmlReader

Source

pub fn from_reader<R: Read + Seek + Send + 'static>(reader: R) -> Result<Self>

Creates an HtmlReader from any Read + Seek source.

The source is streamed via html5gum::IoReader’s 16 KB sliding-window buffer. Memory usage is constant regardless of document size.

The Seek bound is required for API symmetry with other DocSpec readers (e.g., DocxReader), even though html5gum::IoReader only needs Read.

§Errors

This constructor does not read from the source eagerly and therefore currently cannot fail.

Source

pub fn from_str(input: &str) -> Self

Creates an HtmlReader from a string slice.

The input bytes are copied into an owned Vec<u8> and streamed via html5gum::IoReader’s 16 KB sliding-window buffer.

Trait Implementations§

Source§

impl EventSource for HtmlReader

Source§

fn next_event(&mut self) -> Result<Option<Event>>

Returns the next event from the stream, or None if the stream has ended. Read more

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