html5tokenizer/
lib.rs

1#![warn(missing_docs)]
2// This is an HTML parser. HTML can be untrusted input from the internet.
3#![forbid(clippy::undocumented_unsafe_blocks)]
4#![forbid(clippy::multiple_unsafe_ops_per_block)]
5#![doc = concat!("[`examples/spans.rs`]: ", file_url!("examples/spans.rs"))]
6#![doc = concat!("[changelog]: ", file_url!("CHANGELOG.md"))]
7#![doc = concat!("[the LICENSE file]: ", file_url!("LICENSE"))]
8#![doc = include_str!("../README.md")]
9
10mod basic_emitter;
11mod emitter;
12mod entities;
13mod error;
14mod let_else;
15mod naive_parser;
16mod tokenizer;
17mod tracing_emitter;
18
19/// Types for HTML attributes.
20pub mod attr {
21    pub use crate::token::{AttrIntoIter, AttrIter, Attribute, AttributeMap, AttributeOwned};
22    pub use crate::trace::AttrValueSyntax;
23}
24pub mod offset;
25pub mod reader;
26pub mod token;
27pub mod trace;
28
29pub use basic_emitter::BasicEmitter;
30pub use emitter::Emitter;
31pub use error::Error;
32pub use naive_parser::NaiveParser;
33pub use token::{Doctype, EndTag, StartTag, Token};
34pub use tokenizer::{Event, State, Tokenizer};
35pub use tracing_emitter::TracingEmitter;
36
37#[cfg(feature = "integration-tests")]
38pub use tokenizer::InternalState;
39
40/// Relative links in the README.md don't work in rustdoc, so we have to override them.
41macro_rules! file_url {
42    ($path:literal) => {
43        concat!(
44            env!("CARGO_PKG_REPOSITORY"),
45            "/tree/",
46            $path,
47            "?h=v",
48            env!("CARGO_PKG_VERSION")
49        )
50    };
51}